[Zope-Checkins] CVS: Zope3/lib/python/Zope/Publisher - IPublication.py:1.4

Jim Fulton jim@zope.com
Sun, 14 Jul 2002 08:24:16 -0400


Update of /cvs-repository/Zope3/lib/python/Zope/Publisher
In directory cvs.zope.org:/tmp/cvs-serv22106

Modified Files:
	IPublication.py 
Log Message:
Clarified the beforeTraverse hook and reformatted a number of doc
strings to be style-conformant.



=== Zope3/lib/python/Zope/Publisher/IPublication.py 1.3 => 1.4 ===
     # they are invoked.
 
     def beforeTraversal(request):
-        """
-        Pre-traversal hook.
+        """Pre-traversal hook.
+
+        This is called *once* before any traversal has been done.
         """
 
     def getApplication(request):
-        """
-        Returns the object where traversal should commence.
+        """Returns the object where traversal should commence.
         """
 
     def callTraversalHooks(request, ob):
-        """
-        Invokes any traversal hooks associated with the object.
+        """Invokes any traversal hooks associated with the object.
         """
 
     def traverseName(request, ob, name, check_auth=1):
-        """
-        Traverses to the next object.  If check_auth is set,
+        """Traverses to the next object.
+        
+        If check_auth is set,
         performs idenitification, authentication, and authorization.
         Returns the subobject.
         """