diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2016-12-03 09:38:25 -0500 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2016-12-03 09:38:25 -0500 |
| commit | aac9f9f31c0fdb97c52e343be6b8a641b2341232 (patch) | |
| tree | 7bb42d349b45dda67eef390a7c67c71373085d5c | |
| parent | b29c4e27d09781879d3618de72b256373c68809d (diff) | |
| download | python-setuptools-git-aac9f9f31c0fdb97c52e343be6b8a641b2341232.tar.gz | |
Update docs to reflect supported interface. Ref #859.
| -rw-r--r-- | docs/pkg_resources.txt | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt index 9a45b9e3..e8412b33 100644 --- a/docs/pkg_resources.txt +++ b/docs/pkg_resources.txt @@ -831,12 +831,9 @@ correspond exactly to the constructor argument names: ``name``, ``module_name``, ``attrs``, ``extras``, and ``dist`` are all available. In addition, the following methods are provided: -``load(require=True, env=None, installer=None)`` - Load the entry point, returning the advertised Python object, or raise - ``ImportError`` if it cannot be obtained. If `require` is a true value, - then ``require(env, installer)`` is called before attempting the import. - Parameters to load are deprecated. Call ``require`` and ``resolve`` - separately. +``load()`` + Load the entry point, returning the advertised Python object. Effectively + calls ``self.require()`` then returns ``self.resolve()``. ``require(env=None, installer=None)`` Ensure that any "extras" needed by the entry point are available on @@ -850,7 +847,7 @@ addition, the following methods are provided: ``resolve()`` Resolve the entry point from its module and attrs, returning the advertised - Python object. + Python object. Raises ``ImportError`` if it cannot be obtained. ``__str__()`` The string form of an ``EntryPoint`` is a string that could be passed to |
