[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/ Converted documentation to ReST and added some.

[Stephan Richter]

Log message for revision 26613:
  Converted documentation to ReST and added some.
  


Changed:
  U   Zope3/trunk/src/zope/app/container/browser/metaconfigure.py
  U   Zope3/trunk/src/zope/app/fssync/metadirectives.py
  U   Zope3/trunk/src/zope/app/i18n/metadirectives.py
  U   Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py


-=-
Modified: Zope3/trunk/src/zope/app/container/browser/metaconfigure.py
===================================================================
--- Zope3/trunk/src/zope/app/container/browser/metaconfigure.py	2004-07-18 21:48:51 UTC (rev 26612)
+++ Zope3/trunk/src/zope/app/container/browser/metaconfigure.py	2004-07-18 21:50:40 UTC (rev 26613)
@@ -11,10 +11,11 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Container-specific 'browser' ZCML namespace directive handlers
+"""Container-specific ``browser`` ZCML namespace directive handlers
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope.interface import Interface
 from zope.configuration.fields import GlobalObject
 from zope.schema import Id
@@ -25,7 +26,7 @@
 from zope.app.security.fields import Permission
 
 class IContainerViews(Interface):
-    """Define a container views"""
+    """Define several container views for an ``IContainer`` implementation."""
 
     for_ = GlobalObject(
         title=u"The interface this containerViews are for.",

Modified: Zope3/trunk/src/zope/app/fssync/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/fssync/metadirectives.py	2004-07-18 21:48:51 UTC (rev 26612)
+++ Zope3/trunk/src/zope/app/fssync/metadirectives.py	2004-07-18 21:50:40 UTC (rev 26613)
@@ -15,11 +15,17 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope.configuration.fields import GlobalObject
 from zope.interface import Interface
 
 class IAdapterDirective(Interface):
+    """Define a FS Sync adapter.
 
+    Define an adapter for an object that is used to create filesystem
+    representation of the component.
+    """
+
     class_ = GlobalObject(
         title=u"Class",
         description=u"Specifies the class for which this adapter is " \

Modified: Zope3/trunk/src/zope/app/i18n/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/i18n/metadirectives.py	2004-07-18 21:48:51 UTC (rev 26612)
+++ Zope3/trunk/src/zope/app/i18n/metadirectives.py	2004-07-18 21:50:40 UTC (rev 26613)
@@ -11,14 +11,16 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""'i18n' ZCML namespace directive interfaces
+"""``i18n`` ZCML namespace directive interfaces
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope.interface import Interface
 from zope.configuration.fields import Path
 
 class IRegisterTranslationsDirective(Interface):
+    """Register translations with the global Translation Service."""
 
     directory = Path(
         title=u"Directory",

Modified: Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py	2004-07-18 21:48:51 UTC (rev 26612)
+++ Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py	2004-07-18 21:50:40 UTC (rev 26613)
@@ -11,17 +11,21 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Schemas for the 'help' ZCML namespace 
+"""Schemas for the ``help`` ZCML namespace 
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope.configuration.fields import GlobalObject, Path, MessageID, Tokens
 from zope.interface import Interface
 from zope.schema import BytesLine, TextLine
 
 class IRegisterDirective(Interface):
-    """Register directive for onlien help topics."""
+    """Register an online topic.
 
+    Optionally you can register a topic for a component and view.
+    """
+
     id = BytesLine(
         title=u"Topic Id",
         description=u"Id of the topic as it will appear in the URL.",
@@ -57,7 +61,7 @@
 
     resources = Tokens(
         title=u"A list of resources.",
-        description=u"""
+        description=u"""\
         A list of resources which shall be user for the Help Topic.
         The resources must be located in the same directory as
         the Help Topic definition.