[Checkins] SVN: grok/trunk/doc/reference/directives.rst Improve grok.provides documentation
Kevin Teague
kevin at bud.ca
Tue Oct 14 01:20:00 EDT 2008
Log message for revision 92185:
Improve grok.provides documentation
Changed:
U grok/trunk/doc/reference/directives.rst
-=-
Modified: grok/trunk/doc/reference/directives.rst
===================================================================
--- grok/trunk/doc/reference/directives.rst 2008-10-14 01:14:50 UTC (rev 92184)
+++ grok/trunk/doc/reference/directives.rst 2008-10-14 05:19:58 UTC (rev 92185)
@@ -194,14 +194,15 @@
and `zope.interface.verify.verifyObject(interface, object)` to verify if
a class or object actually implements or provides a specific interface.
-:func:`grok.provides` -- declare that a component provides an interface
-=======================================================================
+:func:`grok.provides` -- disambiguate which interface is registered
+===================================================================
.. function:: grok.provides(interface)
- If the component implements more than one interface,
- :func:`grok.provides` is required to disambiguate for what interface
- the component will be registered.
+ Explicitly specify with which interface a component will be
+ looked up. If a class declares that it implements several interaces,
+ :func:`grok.provides` can be used to disambiguate which interface will be
+ registered with the Zope Component Architecture.
.. seealso::
More information about the Checkins
mailing list