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

[Phil Ruggera]

Log message for revision 26534:
  Update doc strings for ReST


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


-=-
Modified: Zope3/trunk/src/zope/app/apidoc/ifacemodule/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/ifacemodule/__init__.py	2004-07-14 18:17:07 UTC (rev 26533)
+++ Zope3/trunk/src/zope/app/apidoc/ifacemodule/__init__.py	2004-07-14 19:55:34 UTC (rev 26534)
@@ -20,6 +20,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.app import zapi
 from zope.interface import implements
 from zope.app.apidoc.interfaces import IDocumentationModule
@@ -39,7 +41,7 @@
 class InterfaceModule(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/ifacemodule/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/ifacemodule/browser.py	2004-07-14 18:17:07 UTC (rev 26533)
+++ Zope3/trunk/src/zope/app/apidoc/ifacemodule/browser.py	2004-07-14 19:55:34 UTC (rev 26534)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from types import FunctionType, MethodType, ClassType, TypeType
 from zope.component import ComponentLookupError
 from zope.interface.declarations import providedBy
@@ -65,7 +67,7 @@
     """Return a list of (name, value) tuples in native interface order.
 
     The type specifies whether we are looking for attributes or methods. The
-    '_itemsorter' argument provides the function that is used to order the
+    `_itemsorter` argument provides the function that is used to order the
     fields. The default function should be the correct one for 99% of your
     needs.
 

Modified: Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py
===================================================================
--- Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py	2004-07-14 18:17:07 UTC (rev 26533)
+++ Zope3/trunk/src/zope/app/apidoc/ifacemodule/menu.py	2004-07-14 19:55:34 UTC (rev 26534)
@@ -19,6 +19,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import implements
 from zope.proxy import removeAllProxies
 
@@ -134,8 +136,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::