[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/annotation/interfaces.py Update doc strings to ReST

Phil Ruggera pruggera at san.rr.com
Tue Jul 13 20:01:29 EDT 2004


Log message for revision 26517:
  Update doc strings to ReST


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


-=-
Modified: Zope3/trunk/src/zope/app/annotation/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/annotation/interfaces.py	2004-07-13 23:48:45 UTC (rev 26516)
+++ Zope3/trunk/src/zope/app/annotation/interfaces.py	2004-07-14 00:01:29 UTC (rev 26517)
@@ -15,25 +15,28 @@
 
 $Id$
 """
+
+__docformat__ = 'restructuredtext'
+
 from zope.interface import Interface
 
 class IAnnotatable(Interface):
     """Marker interface for objects that support storing annotations.
 
     This interface says "There exists an adapter to an IAnnotations
-    for an object that implements IAnnotatable".
+    for an object that implements `IAnnotatable`".
 
     Classes should not directly declare that they implement this interface.
     Instead they should implement an interface derived from this one, which
     details how the annotations are to be stored, such as
-    IAttributeAnnotatable.
+    `IAttributeAnnotatable`.
     """
 
 class IAnnotations(IAnnotatable):
     """Stores arbitrary application data under package-unique keys.
 
     By "package-unique keys", we mean keys that are are unique by
-    virtua of including the dotted name of a package as a prefex.  A
+    virtue of including the dotted name of a package as a prefex.  A
     package name is used to limit the authority for picking names for
     a package to the people using that package.
 
@@ -70,7 +73,7 @@
 class IAttributeAnnotatable(IAnnotatable):
     """Marker indicating that annotations can be stored on an attribute.
     
-    This is a marker interface giving permission for an IAnnotations
-    adapter to store data in an attribute named __annotations__.
+    This is a marker interface giving permission for an `IAnnotations`
+    adapter to store data in an attribute named `__annotations__`.
 
     """



More information about the Zope3-Checkins mailing list