[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/services - registration.py:1.2
Jim Fulton
jim@zope.com
Sun, 22 Jun 2003 10:02:21 -0400
Update of /cvs-repository/Zope3/src/zope/app/interfaces/services
In directory cvs.zope.org:/tmp/cvs-serv22253/src/zope/app/interfaces/services
Modified Files:
registration.py
Log Message:
Provided meaningful doc string for view helper methods.
=== Zope3/src/zope/app/interfaces/services/registration.py 1.1 => 1.2 ===
--- Zope3/src/zope/app/interfaces/services/registration.py:1.1 Sat Jun 21 17:22:10 2003
+++ Zope3/src/zope/app/interfaces/services/registration.py Sun Jun 22 10:02:20 2003
@@ -78,10 +78,23 @@
"""
def usageSummary():
- """Text for line 1 of registration manager summary"""
+ """Single-line usage summary
+
+ This should include the registrayion keys and the kind of
+ registration. For example, a service registration will have a
+ usage summary that indicates a registration for a service of
+ some type. (e.g. "View Service")
+
+ """
def implementationSummary():
- """Text for line 2 of registration manager summary"""
+ """Single-line implementation summary
+
+ This summarizes about the implementation of the thing being
+ registered. For example, for local-component registrations,
+ this will include the component path. For a page registration,
+ this might include a template path and a dotted class name.
+ """
class INamedRegistration(IRegistration):