[Checkins] [zopefoundation/zope.component] b2962c: Reference documentation improvements

Jason Madden noreply at github.com
Fri Jun 26 16:27:42 CEST 2020


  Branch: refs/heads/doc-module
  Home:   https://github.com/zopefoundation/zope.component
  Commit: b2962c1613fb409661d853f9d0e41212fdc0a812
      https://github.com/zopefoundation/zope.component/commit/b2962c1613fb409661d853f9d0e41212fdc0a812
  Author: Jason Madden <jamadden at gmail.com>
  Date:   2020-06-26 (Fri, 26 Jun 2020)

  Changed paths:
    M docs/api.rst
    M docs/api/adapter.rst
    A docs/api/hooks.rst
    A docs/api/module.rst
    M docs/api/utility.rst
    M docs/hooks.rst
    M docs/testlayer.rst
    M src/zope/component/__init__.py
    M src/zope/component/_api.py
    M src/zope/component/_declaration.py
    M src/zope/component/globalregistry.py
    M src/zope/component/hooks.py
    M src/zope/component/interfaces.py

  Log Message:
  -----------
  Reference documentation improvements

- 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.




More information about the checkins mailing list