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

Phil Ruggera pruggera at san.rr.com
Wed Jul 14 18:03:31 EDT 2004


Log message for revision 26539:
  Update doc strings to ReST


Changed:
  U   Zope3/trunk/src/zope/app/apidoc/utilitymodule/__init__.py
  U   Zope3/trunk/src/zope/app/apidoc/utilitymodule/browser.py


-=-
Modified: Zope3/trunk/src/zope/app/apidoc/utilitymodule/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/utilitymodule/__init__.py	2004-07-14 21:57:54 UTC (rev 26538)
+++ Zope3/trunk/src/zope/app/apidoc/utilitymodule/__init__.py	2004-07-14 22:03:31 UTC (rev 26539)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import implements
 
 from zope.app import zapi
@@ -108,7 +110,7 @@
 class UtilityModule(ReadContainerBase):
     r"""Represent the Documentation of all Interfaces.
 
-    This documentation is implemented using a simply 'IReadContainer'. The
+    This documentation is implemented using a simple `IReadContainer`. The
     items of the container are all factories listed in the closest
     factory service and above.
 

Modified: Zope3/trunk/src/zope/app/apidoc/utilitymodule/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/utilitymodule/browser.py	2004-07-14 21:57:54 UTC (rev 26538)
+++ Zope3/trunk/src/zope/app/apidoc/utilitymodule/browser.py	2004-07-14 22:03:31 UTC (rev 26539)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from types import InstanceType
 from zope.app import zapi
 from zope.app.location import LocationProxy
@@ -29,7 +31,7 @@
     def getName(self):
         """Get the name of the utility.
 
-        Return the string "no name", if the utility has no name.
+        Return the string ``no name``, if the utility has no name.
 
         Examples::
 
@@ -118,8 +120,8 @@
     """Menu View Helper Class
 
     A class that helps building the menu. The menu_macros expects the menu view
-    class to have the getMenuTitle(node) and getMenuLink(node) methods
-    implemented. 'node' is a 'zope.app.tree.node.Node' instance.
+    class to have the `getMenuTitle(node)` and `getMenuLink(node)` methods
+    implemented. `node` is a `zope.app.tree.node.Node` instance.
 
     Examples::
 



More information about the Zope3-Checkins mailing list