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

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


Log message for revision 26729:
  Update doc strings to ReST


Changed:
  U   Zope3/trunk/src/zope/app/demo/hellopackage/hellomodule.py
  U   Zope3/trunk/src/zope/app/demo/hellopackage/interfaces.py
  U   Zope3/trunk/src/zope/app/demo/insensitivefolder/__init__.py
  U   Zope3/trunk/src/zope/app/demo/itemvocabulary/__init__.py
  U   Zope3/trunk/src/zope/app/demo/itemvocabulary/browser.py
  U   Zope3/trunk/src/zope/app/demo/jobboard/browser.py
  U   Zope3/trunk/src/zope/app/demo/jobboard/interfaces.py
  U   Zope3/trunk/src/zope/app/demo/jobboard/job.py
  U   Zope3/trunk/src/zope/app/demo/passwdauth/__init__.py
  U   Zope3/trunk/src/zope/app/demo/passwdauth/interfaces.py


-=-
Modified: Zope3/trunk/src/zope/app/demo/hellopackage/hellomodule.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/hellopackage/hellomodule.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/hellopackage/hellomodule.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from interfaces import IHello
 from persistent import Persistent
 from zope.interface import implements

Modified: Zope3/trunk/src/zope/app/demo/hellopackage/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/hellopackage/interfaces.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/hellopackage/interfaces.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import Interface
 
 class IHello(Interface):

Modified: Zope3/trunk/src/zope/app/demo/insensitivefolder/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/insensitivefolder/__init__.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/insensitivefolder/__init__.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.app import zapi
 from zope.app.folder import Folder
 from zope.app.folder.interfaces import IFolder

Modified: Zope3/trunk/src/zope/app/demo/itemvocabulary/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/itemvocabulary/__init__.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/itemvocabulary/__init__.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -13,11 +13,13 @@
 ##############################################################################
 """Item Vocabulary
 
-Given a context object that implements 'IEnumerableMapping', the vocabulary
+Given a context object that implements `IEnumerableMapping`, the vocabulary
 displays all items of that context object. 
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import implements
 from zope.schema.interfaces import \
      ITokenizedTerm, IVocabulary, IVocabularyTokenized
@@ -32,7 +34,7 @@
 
 
 class ItemVocabulary(object):
-    """A vocabulary that provides the keys of any IEnumerableMapping object.
+    """A vocabulary that provides the keys of any `IEnumerableMapping` object.
 
     Every dictionary will qualify for this vocabulary.
 

Modified: Zope3/trunk/src/zope/app/demo/itemvocabulary/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/itemvocabulary/browser.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/itemvocabulary/browser.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import implements, Interface
 from zope.schema.vocabulary import VocabularyField
 from zope.app.content.folder import Folder

Modified: Zope3/trunk/src/zope/app/demo/jobboard/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/jobboard/browser.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/jobboard/browser.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
 from zope.app.publisher.browser import BrowserView
 from zope.event import notify

Modified: Zope3/trunk/src/zope/app/demo/jobboard/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/jobboard/interfaces.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/jobboard/interfaces.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import Interface
 from zope.interface import Attribute
 

Modified: Zope3/trunk/src/zope/app/demo/jobboard/job.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/jobboard/job.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/jobboard/job.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from persistent import Persistent
 from interfaces import IJob, JobState, IJobList
 from zope.interface import implements

Modified: Zope3/trunk/src/zope/app/demo/passwdauth/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/passwdauth/__init__.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/passwdauth/__init__.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -18,6 +18,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 import os
 from persistent import Persistent
 from zope.app.container.contained import Contained
@@ -51,7 +53,7 @@
         return principals
 
     def getPrincipal(self, id):
-        """See IPrincipalSource."""
+        """See `IPrincipalSource`."""
         earmark, source_name, id = id.split('\t')
         for p in self.readPrincipals():
             if p._id == id:
@@ -59,12 +61,12 @@
         raise NotFoundError, id
 
     def getPrincipals(self, name):
-        """See IPrincipalSource."""
+        """See `IPrincipalSource`."""
         return filter(lambda p: p.login.find(name) != -1,
                       self.readPrincipals())
 
     def authenticate(self, login, password):
-        """See ILoginPasswordPrincipalSource. """
+        """See `ILoginPasswordPrincipalSource`. """
         for user in self.readPrincipals():
             if user.login == login and user.password == password:
                 return user

Modified: Zope3/trunk/src/zope/app/demo/passwdauth/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/passwdauth/interfaces.py	2004-07-23 21:19:07 UTC (rev 26728)
+++ Zope3/trunk/src/zope/app/demo/passwdauth/interfaces.py	2004-07-23 21:20:21 UTC (rev 26729)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.schema import TextLine
 from zope.app.i18n import ZopeMessageIDFactory as _
 



More information about the Zope3-Checkins mailing list