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

[Phil Ruggera]

Log message for revision 26618:
  Update doc strings to ReST


Changed:
  U   Zope3/trunk/src/zope/app/component/contentdirective.py
  U   Zope3/trunk/src/zope/app/component/hooks.py
  U   Zope3/trunk/src/zope/app/component/interface.py
  U   Zope3/trunk/src/zope/app/component/localservice.py
  U   Zope3/trunk/src/zope/app/component/metaconfigure.py
  U   Zope3/trunk/src/zope/app/component/metadirectives.py


-=-
Modified: Zope3/trunk/src/zope/app/component/contentdirective.py
===================================================================
--- Zope3/trunk/src/zope/app/component/contentdirective.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/contentdirective.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from types import ModuleType
 from zope.interface import classImplements
 from zope.schema.interfaces import IField

Modified: Zope3/trunk/src/zope/app/component/hooks.py
===================================================================
--- Zope3/trunk/src/zope/app/component/hooks.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/hooks.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 import zope.component
 from zope.component import getService
 from zope.component.interfaces import IServiceService

Modified: Zope3/trunk/src/zope/app/component/interface.py
===================================================================
--- Zope3/trunk/src/zope/app/component/interface.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/interface.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.component.exceptions import ComponentLookupError
 from zope.interface import directlyProvides
 from zope.interface.interfaces import IInterface
@@ -116,7 +118,7 @@
     return iface
 
 def queryInterface(id, default=None):
-    """return interface or None
+    """return interface or ``None``
 
     >>> from zope.app.tests.placelesssetup import setUp, tearDown
     >>> tearDown()

Modified: Zope3/trunk/src/zope/app/component/localservice.py
===================================================================
--- Zope3/trunk/src/zope/app/component/localservice.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/localservice.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,7 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 
 from zope.interface import implements
 from zope.component.exceptions import ComponentLookupError
@@ -74,7 +75,7 @@
     return getNextServices(context).getService(name)
 
 def getNextServices(context):
-    """Returns the next service manager to the one that contains 'context'.
+    """Returns the next service manager to the one that contains `context`.
     """
     services = getLocalServices(context).next
     if IGlobalServiceManager.providedBy(services):
@@ -94,12 +95,12 @@
         return default
 
 def getLocalServices(context):
-    """Returns the service manager that contains 'context'.
+    """Returns the service manager that contains `context`.
 
-    If context is a local service, returns the service manager that
-    contains that service. If context is a service manager, returns context.
+    If `context` is a local service, returns the service manager that
+    contains that service. If `context` is a service manager, returns `context`.
 
-    Otherwise, raises ComponentLookupError('Services')
+    Otherwise, raises ``ComponentLookupError('Services')``
     """
 
     # IMPORTANT
@@ -118,7 +119,7 @@
     """An adapter ILocation -> IServiceService.
 
     The ILocation is interpreted flexibly, we just check for
-    __parent__.
+    ``__parent__``.
     """
     current = ob
     while True:

Modified: Zope3/trunk/src/zope/app/component/metaconfigure.py
===================================================================
--- Zope3/trunk/src/zope/app/component/metaconfigure.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/metaconfigure.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 from zope.interface import Interface
 from zope.component.service import UndefinedService
 from zope.configuration.exceptions import ConfigurationError
@@ -61,7 +63,7 @@
 
 
 def proxify(ob, checker):
-    """Try to get the object proxied with the checker, but not too soon
+    """Try to get the object proxied with the `checker`, but not too soon
 
     We really don't want to proxy the object unless we need to.
     """

Modified: Zope3/trunk/src/zope/app/component/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/component/metadirectives.py	2004-07-19 03:25:41 UTC (rev 26617)
+++ Zope3/trunk/src/zope/app/component/metadirectives.py	2004-07-19 03:35:43 UTC (rev 26618)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 import zope.configuration.fields
 import zope.interface
 import zope.schema