[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/dependable/ Update doc strings to ReST

Phil Ruggera pruggera at san.rr.com
Fri Jul 23 17:23:27 EDT 2004


Log message for revision 26730:
  Update doc strings to ReST


Changed:
  U   Zope3/trunk/src/zope/app/dependable/__init__.py
  U   Zope3/trunk/src/zope/app/dependable/interfaces.py


-=-
Modified: Zope3/trunk/src/zope/app/dependable/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/dependable/__init__.py	2004-07-23 21:20:21 UTC (rev 26729)
+++ Zope3/trunk/src/zope/app/dependable/__init__.py	2004-07-23 21:23:27 UTC (rev 26730)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from interfaces import IDependable
 from zope.app.annotation.interfaces import IAnnotations
 from zope.app.traversing.api import getParent, canonicalPath, getPath
@@ -25,7 +27,7 @@
     """Abstract base class for annotations that are sets of paths.
 
     To make this into a concrete class, a subclass must set the class
-    attribute 'key' to a unique annotation key.  A subclass may also
+    attribute `key` to a unique annotation key.  A subclass may also
     choose to rename the methods.
     """
 
@@ -90,7 +92,7 @@
 
 
 class Dependable(PathSetAnnotation):
-    """See IDependable."""
+    """See `IDependable`."""
 
     implements(IDependable)
 

Modified: Zope3/trunk/src/zope/app/dependable/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/dependable/interfaces.py	2004-07-23 21:20:21 UTC (rev 26729)
+++ Zope3/trunk/src/zope/app/dependable/interfaces.py	2004-07-23 21:23:27 UTC (rev 26730)
@@ -15,13 +15,15 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import Interface
 from zope.app.exception.interfaces import UserError
 
 class IDependable(Interface):
     """Objects that other objects depend on.
 
-    Note that IDependable will normally be implemented by an adapter.
+    Note that `IDependable` will normally be implemented by an adapter.
     """
 
     def addDependent(location):



More information about the Zope3-Checkins mailing list