diff options
| author | Jason Madden <jamadden@gmail.com> | 2020-06-26 09:24:29 -0500 |
|---|---|---|
| committer | Jason Madden <jamadden@gmail.com> | 2020-06-26 09:24:29 -0500 |
| commit | b2962c1613fb409661d853f9d0e41212fdc0a812 (patch) | |
| tree | 485ef0a991daf6d903f56e101fa9c818438bf781 /docs/api.rst | |
| parent | 7f69616898ea1c68d424e6d1fadaa5737c102a74 (diff) | |
| download | zope-component-doc-module.tar.gz | |
Reference documentation improvementsdoc-module
- Make it possible to use :mod:`zope.component`
- Provide a concise list of all the available APIs in that module and
link them to their in-depth descriptions.
- Fix several xref errors
- Add documentation for setHooks/resetHooks.
This also makes it possible to get useful help at the REPL or command
line:
$ python -c 'import zope.component; help(zope.component.getAdapters)'
Help on function getAdapters in module zope.component._api:
getAdapters(objects, provided, context=None)
Look for all matching adapters to a provided interface for
objects
Return a list of adapters that match. If an adapter is named,
only the most specific adapter of a given name is returned.
.. seealso::
Function `~zope.component.getAdapters` for notes, and
`~zope.component.interfaces.IComponentArchitecture` for the defining interface.
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/api.rst b/docs/api.rst index 286255f..9b7fee0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,10 +1,12 @@ -:mod:`zope.component` API Reference -=================================== +===================================== + ``zope.component`` API Reference +===================================== .. toctree:: :maxdepth: 2 + api/module api/interfaces api/sitemanager api/utility @@ -13,3 +15,4 @@ api/interface api/security api/persistent + api/hooks |