Commit aac9f9f3 authored by Jason R. Coombs's avatar Jason R. Coombs

Update docs to reflect supported interface. Ref #859.

parent b29c4e27
...@@ -831,12 +831,9 @@ correspond exactly to the constructor argument names: ``name``, ...@@ -831,12 +831,9 @@ correspond exactly to the constructor argument names: ``name``,
``module_name``, ``attrs``, ``extras``, and ``dist`` are all available. In ``module_name``, ``attrs``, ``extras``, and ``dist`` are all available. In
addition, the following methods are provided: addition, the following methods are provided:
``load(require=True, env=None, installer=None)`` ``load()``
Load the entry point, returning the advertised Python object, or raise Load the entry point, returning the advertised Python object. Effectively
``ImportError`` if it cannot be obtained. If `require` is a true value, calls ``self.require()`` then returns ``self.resolve()``.
then ``require(env, installer)`` is called before attempting the import.
Parameters to load are deprecated. Call ``require`` and ``resolve``
separately.
``require(env=None, installer=None)`` ``require(env=None, installer=None)``
Ensure that any "extras" needed by the entry point are available on Ensure that any "extras" needed by the entry point are available on
...@@ -850,7 +847,7 @@ addition, the following methods are provided: ...@@ -850,7 +847,7 @@ addition, the following methods are provided:
``resolve()`` ``resolve()``
Resolve the entry point from its module and attrs, returning the advertised Resolve the entry point from its module and attrs, returning the advertised
Python object. Python object. Raises ``ImportError`` if it cannot be obtained.
``__str__()`` ``__str__()``
The string form of an ``EntryPoint`` is a string that could be passed to The string form of an ``EntryPoint`` is a string that could be passed to
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment