summaryrefslogtreecommitdiff
path: root/docs/api/utility.rst
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2020-06-26 09:24:29 -0500
committerJason Madden <jamadden@gmail.com>2020-06-26 09:24:29 -0500
commitb2962c1613fb409661d853f9d0e41212fdc0a812 (patch)
tree485ef0a991daf6d903f56e101fa9c818438bf781 /docs/api/utility.rst
parent7f69616898ea1c68d424e6d1fadaa5737c102a74 (diff)
downloadzope-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/utility.rst')
-rw-r--r--docs/api/utility.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/api/utility.rst b/docs/api/utility.rst
index a6000b8..cbc4e17 100644
--- a/docs/api/utility.rst
+++ b/docs/api/utility.rst
@@ -1,5 +1,8 @@
-Utility Registration APIs
-=========================
+===========================
+ Utility Registration APIs
+===========================
+
+.. autofunction:: zope.component.provideUtility
.. autofunction:: zope.component.getUtility
@@ -56,7 +59,7 @@ Now the component is available:
Named Utilities
----------------
+===============
Registering a utility without a name does not mean that it is available
when looking for the utility with a name:
@@ -84,7 +87,7 @@ Registering the utility under the correct name makes it available:
True
Querying Multiple Utilities
----------------------------
+===========================
.. autofunction:: zope.component.getUtilitiesFor
@@ -159,7 +162,7 @@ the utilities.
Delegated Utility Lookup
-------------------------
+========================
.. autofunction:: zope.component.getNextUtility