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

Phil Ruggera pruggera at san.rr.com
Wed Jul 14 16:30:06 EDT 2004


Log message for revision 26535:
  Update doc strings for ReST


Changed:
  U   Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py
  U   Zope3/trunk/src/zope/app/apidoc/servicemodule/__init__.py
  U   Zope3/trunk/src/zope/app/apidoc/servicemodule/browser.py


-=-
Modified: Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py	2004-07-14 19:55:34 UTC (rev 26534)
+++ Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py	2004-07-14 20:30:06 UTC (rev 26535)
@@ -137,7 +137,7 @@
 
     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.
+    implemented. `node` is a `zope.app.tree.node.Node` instance.
 
     Examples::
 

Modified: Zope3/trunk/src/zope/app/apidoc/servicemodule/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/servicemodule/__init__.py	2004-07-14 19:55:34 UTC (rev 26534)
+++ Zope3/trunk/src/zope/app/apidoc/servicemodule/__init__.py	2004-07-14 20:30:06 UTC (rev 26535)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import implements
 from zope.component import ComponentLookupError
 
@@ -41,7 +43,7 @@
 class ServiceModule(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 the interfaces listed in the closest
     interface service and above.
 

Modified: Zope3/trunk/src/zope/app/apidoc/servicemodule/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/servicemodule/browser.py	2004-07-14 19:55:34 UTC (rev 26534)
+++ Zope3/trunk/src/zope/app/apidoc/servicemodule/browser.py	2004-07-14 20:30:06 UTC (rev 26535)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.proxy import removeAllProxies
 
 from zope.app import zapi
@@ -25,7 +27,7 @@
 class Menu(object):
     """Menu View Helper Class
 
-    'node' is a 'zope.app.tree.node.Node' instance.
+    `node` is a `zope.app.tree.node.Node` instance.
 
     Examples::
 



More information about the Zope3-Checkins mailing list