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 /src/zope/component/__init__.py | |
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 'src/zope/component/__init__.py')
-rw-r--r-- | src/zope/component/__init__.py | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/src/zope/component/__init__.py b/src/zope/component/__init__.py index 77e12cc..6aee904 100644 --- a/src/zope/component/__init__.py +++ b/src/zope/component/__init__.py @@ -11,7 +11,16 @@ # FOR A PARTICULAR PURPOSE. # ############################################################################## -"""Zope 3 Component Architecture +""" +Zope 3 Component Architecture + +This module provides an implementation of +:class:`~zope.component.interfaces.IComponentArchitecture`, using the +current :mod:`site <zope.component.hooks>`. + +This module also provides an implementation of +:class:`~zope.component.interfaces.IComponentRegistrationConvenience` +using the `global site manager <getGlobalSiteManager>`_. """ from zope.interface import Interface from zope.interface import implementedBy @@ -58,4 +67,9 @@ from zope.component._declaration import adapter from zope.component._declaration import adapts moduleProvides(IComponentArchitecture, IComponentRegistrationConvenience) -__all__ = tuple(IComponentArchitecture) +__all__ = tuple(IComponentArchitecture) + tuple(IComponentRegistrationConvenience) + ( + 'named', + 'adapts', + 'adapter', + 'adaptedBy', +) |