[Zope3-checkins] SVN: Zope3/trunk/src/ Fixed docstrings and whitespaces.

Stephan Richter srichter at cosmos.phy.tufts.edu
Sun Oct 30 15:16:11 EST 2005


Log message for revision 39752:
  Fixed docstrings and whitespaces.
  

Changed:
  U   Zope3/trunk/src/buddydemo/buddy.py
  U   Zope3/trunk/src/bugtracker/I18N.txt
  U   Zope3/trunk/src/bugtracker/LICENSE.txt
  U   Zope3/trunk/src/zope/app/component/metaconfigure.py
  U   Zope3/trunk/src/zope/app/component/vocabulary.py
  U   Zope3/trunk/src/zope/app/dav/interfaces.py
  U   Zope3/trunk/src/zope/app/dav/meta.zcml
  U   Zope3/trunk/src/zope/app/decorator.py
  U   Zope3/trunk/src/zope/app/demo/jobboard/job.py
  U   Zope3/trunk/src/zope/app/exception/browser/configure.zcml
  U   Zope3/trunk/src/zope/app/form/browser/editview.py
  U   Zope3/trunk/src/zope/app/form/browser/editwizard.py
  U   Zope3/trunk/src/zope/app/form/browser/objectwidget.py
  U   Zope3/trunk/src/zope/app/i18n/interfaces.py
  U   Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py
  U   Zope3/trunk/src/zope/app/onlinehelp/interfaces.py
  U   Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py
  U   Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py
  U   Zope3/trunk/src/zope/app/pluggableauth/interfaces.py
  U   Zope3/trunk/src/zope/app/publication/interfaces.py
  U   Zope3/trunk/src/zope/app/publication/requestpublicationregistry.py
  U   Zope3/trunk/src/zope/app/publisher/xmlrpc/README.txt
  U   Zope3/trunk/src/zope/app/pythonpage/__init__.py
  U   Zope3/trunk/src/zope/app/rdb/interfaces.py
  U   Zope3/trunk/src/zope/app/session/session.py
  U   Zope3/trunk/src/zope/app/twisted/http.py
  U   Zope3/trunk/src/zope/app/workflow/stateful/browser/interfaces.py
  U   Zope3/trunk/src/zope/component/bbb/adapter.py
  U   Zope3/trunk/src/zope/configuration/xmlconfig.py
  U   Zope3/trunk/src/zope/i18n/interfaces/__init__.py
  U   Zope3/trunk/src/zope/interface/common/sequence.py
  U   Zope3/trunk/src/zope/interface/interfaces.py
  U   Zope3/trunk/src/zope/schema/interfaces.py
  U   Zope3/trunk/src/zope/tales/tales.py
  U   Zope3/trunk/src/zope/testbrowser/mechanize/_mechanize.py
  U   Zope3/trunk/src/zwiki/I18N.txt
  U   Zope3/trunk/src/zwiki/interfaces.py

-=-
Modified: Zope3/trunk/src/buddydemo/buddy.py
===================================================================
--- Zope3/trunk/src/buddydemo/buddy.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/buddydemo/buddy.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,3 +1,5 @@
+__docformat__ = 'restructuredtext'
+
 import persistent
 import zope.interface
 from buddydemo.interfaces import IBuddy
@@ -22,6 +24,7 @@
     def name(self):
         return "%s %s" % (self.first, self.last)
 
+
 from zope.app.container.btree import BTreeContainer
 from buddydemo.interfaces import IBuddyFolder
 
@@ -29,8 +32,6 @@
     zope.interface.implements(IBuddyFolder)
 
 
-
-
 class BuddyCityState:
     """Provide city and state information for a buddy
 
@@ -78,4 +79,3 @@
             self.city, self.state = '', ''
         else:
             self.city, self.state = info.city, info.state
-        

Modified: Zope3/trunk/src/bugtracker/I18N.txt
===================================================================
--- Zope3/trunk/src/bugtracker/I18N.txt	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/bugtracker/I18N.txt	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,36 +1,38 @@
+===================================================
 Internationalization (I18n) and Localization (L10n)
-=====================================================
+===================================================
 
-  Creating/Updating Message Catalog Template (POT) Files
-  -----------------------------------------------------
+Creating/Updating Message Catalog Template (POT) Files
+------------------------------------------------------
 
-    1. Install 'bugtracker' in 'ZOPE3/src'. See INSTALL.txt for details.
+1. Install `bugtracker` in `ZOPE3/src`. See `INSTALL.txt` for details.
 
-    2. Set the the Python path::
+2. Set the the Python path::
 
-        export PYTHONPATH=ZOPE3/src
+    export PYTHONPATH=ZOPE3/src
 
-    3. Go into the 'locales' directory and execute i18nextract.py::
+3. Go into the `locales` directory and execute `i18nextract.py`::
 
-      python2.4 utilities/i18nextract.py -d bugtracker -p ..
+    python2.4 utilities/i18nextract.py -d bugtracker -p ..
 
 
-  Updating Message Catalog (PO) Files
-  -----------------------------------
+Updating Message Catalog (PO) Files
+-----------------------------------
 
-    1. For each language do simply::
+1. For each language do simply::
 
-        msgmerge -U de/LC_MESSAGES/bugtracker.po bugtracker.pot
+    msgmerge -U de/LC_MESSAGES/bugtracker.po bugtracker.pot
 
-    2. Translate the updated PO file. 
-       Note: KBabel is a great tool for this task!
+2. Translate the updated PO file.
 
+   Note: KBabel is a great tool for this task!
 
-  Compiling Message Catalogs (PO) to binary (MO) Files
-  ----------------------------------------------------
 
-    1. Go to the right directory, such as '<bugtracker>/locales/de/LC_MESSAGES'.
+Compiling Message Catalogs (PO) to binary (MO) Files
+----------------------------------------------------
 
-    2. Run the following command::
+1. Go to the right directory, such as `<bugtracker>/locales/de/LC_MESSAGES`.
 
-        msgfmt -o bugtracker.mo bugtracker.po
+2. Run the following command::
+
+    msgfmt -o bugtracker.mo bugtracker.po

Modified: Zope3/trunk/src/bugtracker/LICENSE.txt
===================================================================
--- Zope3/trunk/src/bugtracker/LICENSE.txt	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/bugtracker/LICENSE.txt	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,5 +1,6 @@
+=====================================
 Zope Public License (ZPL) Version 2.1
--------------------------------------
+=====================================
 
 A copyright notice accompanies this license document that
 identifies the copyright holders.
@@ -37,18 +38,19 @@
    the files and the date of any change.
 
 Disclaimer
+----------
 
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS''
-  AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
-  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
-  NO EVENT SHALL THE COPYRIGHT HOLDERS BE
-  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-  DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "AS IS"
+AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
+NO EVENT SHALL THE COPYRIGHT HOLDERS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

Modified: Zope3/trunk/src/zope/app/component/metaconfigure.py
===================================================================
--- Zope3/trunk/src/zope/app/component/metaconfigure.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/component/metaconfigure.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -97,7 +97,7 @@
         if for_ is None:
             raise TypeError("No for attribute was provided and can't "
                             "determine what the factory (or handler) adapts.")
-    
+
     factory = [factory]
 
     if permission is not None:
@@ -127,10 +127,10 @@
         if trusted:
             factory = LocatingTrustedAdapterFactory(factory)
         else:
-            factory = LocatingUntrustedAdapterFactory(factory) 
+            factory = LocatingUntrustedAdapterFactory(factory)
     else:
         if trusted:
-            factory = TrustedAdapterFactory(factory) 
+            factory = TrustedAdapterFactory(factory)
 
     _context.action(
         discriminator = None,
@@ -145,7 +145,7 @@
             callable = provideInterface,
             args = ('', provides)
             )
-    
+
     # For each interface, state that the adapter provides that interface.
     for iface in for_:
         if iface is not None:
@@ -161,7 +161,7 @@
     if for_ is None:
         if len(factory) == 1:
             for_ = component.adaptedBy(factory[0])
-       
+
         if for_ is None:
             raise TypeError("No for attribute was provided and can't "
                             "determine what the factory adapts.")
@@ -175,7 +175,7 @@
                 provides = p[0]
 
         if provides is None:
-            raise TypeError("Missing 'provides' attribute")            
+            raise TypeError("Missing 'provides' attribute")
 
     # Generate a single factory from multiple factories:
     factories = factory
@@ -199,10 +199,10 @@
         if trusted:
             factory = LocatingTrustedAdapterFactory(factory)
         else:
-            factory = LocatingUntrustedAdapterFactory(factory) 
+            factory = LocatingUntrustedAdapterFactory(factory)
     else:
         if trusted:
-            factory = TrustedAdapterFactory(factory) 
+            factory = TrustedAdapterFactory(factory)
 
     _context.action(
         discriminator = ('adapter', for_, provides, name),
@@ -244,7 +244,7 @@
             ob.__Security_checker__ = checker
         except AttributeError:
             ob = Proxy(ob, checker)
-        
+
         return ob
     factory.factory = factory
     return factory
@@ -286,7 +286,7 @@
 def factory(_context, component, id, title=None, description=None):
     if title is not None:
         component.title = title
-        
+
     if description is not None:
         component.description = description
 
@@ -427,7 +427,7 @@
             callable = provideInterface,
             args = ('', type)
             )
-        
+
     _context.action(
         discriminator = None,
         callable = provideInterface,
@@ -453,7 +453,7 @@
         args = ('provideAdapter',
                 (for_, type), IDefaultViewName, '', name, _context.info)
         )
-    
+
     _context.action(
         discriminator = None,
         callable = provideInterface,

Modified: Zope3/trunk/src/zope/app/component/vocabulary.py
===================================================================
--- Zope3/trunk/src/zope/app/component/vocabulary.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/component/vocabulary.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -17,6 +17,8 @@
 
 $Id$
 """
+__docformat__ = "reStructuredText"
+
 from zope.interface import implements, Interface
 from zope.interface.interfaces import IInterface
 from zope.interface.verify import verifyObject
@@ -124,9 +126,9 @@
 
     Next we are looking at some of the more vocabulary-characteristic API
     methods.
-    
-    One can get a term for a given value using getTerm():
 
+    One can get a term for a given value using ``getTerm()``:
+
     >>> vocab.getTerm(object1)
     <UtiltiyTerm object1, instance of Object>
     >>> vocab.getTerm(object4)
@@ -146,7 +148,7 @@
 
     That's it. It is all pretty straight forward, but it allows us to easily
     create a vocabulary for any utility. In fact, to make it easy to register
-    such a vocabulary via ZCML, the 'interface' argument to the constructor
+    such a vocabulary via ZCML, the `interface` argument to the constructor
     can be a string that is resolved via the utility registry. The ZCML looks
     like this:
 
@@ -164,7 +166,7 @@
      (u'object3', <UtiltiyTerm object3, instance of Object>)]
 
     Sometimes it is desirable to only select the name of a utility. For
-    this purpose a 'nameOnly' argument was added to the constructor, in which
+    this purpose a `nameOnly` argument was added to the constructor, in which
     case the UtilityTerm's value is not the utility itself but the name of the
     utility.
 
@@ -322,7 +324,6 @@
     u''
 
     >>> placelesssetup.tearDown()
-
     """
 
     implements(IVocabularyTokenized)

Modified: Zope3/trunk/src/zope/app/dav/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/dav/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/dav/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -40,52 +40,48 @@
 
 class IDAVCreationDate(Interface):
 
-    creationdate = Text(title=u'''Records the time and date the resource\
-                                was created''',
+    creationdate = Text(
+        title=u'''Records the time and date the resource was created''',
 
-                        description=u'''\
-                                The creationdate property should be
-                                defined on all DAV compliant
-                                resources.  If present, it contains a
-                                timestamp of the moment when the
-                                resource was created (i.e., the moment
-                                it had non- null state).''',
+        description=u'''The creationdate property should be defined on all
+                         DAV compliant resources. If present, it contains a
+                         timestamp of the moment when the resource was
+                         created (i.e., the moment it had non- null state).''',
 
-                            readonly=True)
+        readonly=True)
 
 
 class IDAVDisplayName(Interface):
 
-    displayname = Text(title=u'''Provides a name for the resource that\
-                                is suitable for presentation to a\
-                                user''',
+    displayname = Text(
+        title=u'''Provides a name for the resource that is suitable for\
+                  presentation to a user''',
 
-                       description=u'''\
-                                The displayname property should be
-                                defined on all DAV compliant
-                                resources.  If present, the property
-                                contains a description of the resource
-                                that is suitable for presentation to a
-                                user.''')
+        description=u'''The displayname property should be
+                        defined on all DAV compliant
+                        resources.  If present, the property
+                        contains a description of the resource
+                        that is suitable for presentation to a
+                        user.''')
 
 class IDAVSource(Interface):
 
-    source = Text(title=u'''The destination of the source link\
-                                identifies the resource that contains\
-                                the unprocessed source of the link\
-                                source''',
+    source = Text(
+        title=u'''The destination of the source link\
+                  identifies the resource that contains\
+                  the unprocessed source of the link\
+                  source''',
 
-                  description=u'''\
-                                The source of the link (src) is
-                                typically the URI of the output
-                                resource on which the link is defined,
-                                and there is typically only one
-                                destination (dst) of the link, which
-                                is the URI where the unprocessed
-                                source of the resource may be
-                                accessed.  When more than one link
-                                destination exists, this specification
-                                asserts no policy on ordering.''')
+        description=u'''The source of the link (src) is
+                        typically the URI of the output
+                        resource on which the link is defined,
+                        and there is typically only one
+                        destination (dst) of the link, which
+                        is the URI where the unprocessed
+                        source of the resource may be
+                        accessed.  When more than one link
+                        destination exists, this specification
+                        asserts no policy on ordering.''')
 
 
 class IOptionalDAVSchema(IDAVCreationDate, IDAVDisplayName, IDAVSource):
@@ -95,67 +91,67 @@
 class IGETDependentDAVSchema(Interface):
     """DAV properties that are dependent on GET support of the resource"""
 
-    getcontentlanguage = Text(title=u'''Contains the Content-Language\
-                                header returned by a GET without\
-                                accept headers''',
+    getcontentlanguage = Text(
+        title=u'''Contains the Content-Language\
+                  header returned by a GET without\
+                  accept headers''',
 
-                              description=u'''\
-                                The getcontentlanguage property MUST
-                                be defined on any DAV compliant
-                                resource that returns the
-                                Content-Language header on a GET.''')
+        description=u'''The getcontentlanguage property MUST
+                        be defined on any DAV compliant
+                        resource that returns the
+                        Content-Language header on a GET.''')
 
-    getcontentlength = Text(title=u'''Contains the Content-Length header\
-                                returned by a GET without accept\
-                                headers''',
+    getcontentlength = Text(
+        title=u'''Contains the Content-Length header\
+                  returned by a GET without accept\
+                  headers''',
 
-                            description=u'''\
-                                The getcontentlength property MUST be
-                                defined on any DAV compliant resource
-                                that returns the Content-Length header
-                                in response to a GET.''',
+        description=u'''The getcontentlength property MUST be
+                        defined on any DAV compliant resource
+                        that returns the Content-Length header
+                        in response to a GET.''',
 
-                            readonly=True)
+        readonly=True)
 
-    getcontenttype = Text(title=u'''Contains the Content-Type header\
-                                returned by a GET without accept\
-                                headers''',
+    getcontenttype = Text(
+        title=u'''Contains the Content-Type header\
+                  returned by a GET without accept\
+                  headers''',
 
-                          description=u'''\
-                                This getcontenttype property MUST be
-                                defined on any DAV compliant resource
-                                that returns the Content-Type header
-                                in response to a GET.''')
+        description=u'''This getcontenttype property MUST be
+                        defined on any DAV compliant resource
+                        that returns the Content-Type header
+                        in response to a GET.''')
 
-    getetag = Text(title=u'''Contains the ETag header returned by a GET\
-                                without accept headers''',
+    getetag = Text(
+        title=u'''Contains the ETag header returned by a GET\
+                  without accept headers''',
 
-                   description=u'''\
-                                The getetag property MUST be defined
-                                on any DAV compliant resource that
-                                returns the Etag header.''',
+        description=u'''The getetag property MUST be defined
+                        on any DAV compliant resource that
+                        returns the Etag header.''',
 
-                            readonly=True)
+        readonly=True)
 
-    getlastmodified = Text(title=u'''Contains the Last-Modified header\
-                                returned by a GET method without\
-                                accept headers''',
+    getlastmodified = Text(
+        title=u'''Contains the Last-Modified header\
+                  returned by a GET method without\
+                  accept headers''',
 
-                           description=u'''\
-                                Note that the last-modified date on a
-                                resource may reflect changes in any
-                                part of the state of the resource, not
-                                necessarily just a change to the
-                                response to the GET method.  For
-                                example, a change in a property may
-                                cause the last-modified date to
-                                change. The getlastmodified property
-                                MUST be defined on any DAV compliant
-                                resource that returns the
-                                Last-Modified header in response to a
-                                GET.''',
+        description=u'''Note that the last-modified date on a
+                        resource may reflect changes in any
+                        part of the state of the resource, not
+                        necessarily just a change to the
+                        response to the GET method.  For
+                        example, a change in a property may
+                        cause the last-modified date to
+                        change. The getlastmodified property
+                        MUST be defined on any DAV compliant
+                        resource that returns the
+                        Last-Modified header in response to a
+                        GET.''',
 
-                            readonly=True)
+        readonly=True)
 
 
 class IDAV1Schema(IGETDependentDAVSchema):
@@ -163,7 +159,7 @@
 
     resourcetype = XMLText(title=u'''Specifies the nature of the resource''',
 
-                           description=u'''\
+                           description=u'''
                                 The resourcetype property MUST be
                                 defined on all DAV compliant
                                 resources.  The default value is
@@ -175,40 +171,38 @@
 class IDAV2Schema(IDAV1Schema):
     """DAV properties required for Level 2 compliance"""
 
-    lockdiscovery = Text(title=u'''Describes the active locks on a\
-                                 resource''',
+    lockdiscovery = Text(
+        title=u'''Describes the active locks on a resource''',
 
-                         description=u'''\
-                                 The lockdiscovery property returns a
-                                 listing of who has a lock, what type
-                                 of lock he has, the timeout type and
-                                 the time remaining on the timeout,
-                                 and the associated lock token.  The
-                                 server is free to withhold any or all
-                                 of this information if the requesting
-                                 principal does not have sufficient
-                                 access rights to see the requested
-                                 data.''',
+        description=u'''The lockdiscovery property returns a
+                        listing of who has a lock, what type
+                        of lock he has, the timeout type and
+                        the time remaining on the timeout,
+                        and the associated lock token.  The
+                        server is free to withhold any or all
+                        of this information if the requesting
+                        principal does not have sufficient
+                        access rights to see the requested
+                        data.''',
 
-                            readonly=True)
+        readonly=True)
 
-    supportedlock = Text(title=u'''To provide a listing of the lock\
-                                capabilities supported by the\
-                                resource''',
+    supportedlock = Text(
+        title=u'''To provide a listing of the lock\
+                  capabilities supported by the resource''',
 
-                         description=u'''\
-                                The supportedlock property of a
-                                resource returns a listing of the
-                                combinations of scope and access types
-                                which may be specified in a lock
-                                request on the resource.  Note that
-                                the actual contents are themselves
-                                controlled by access controls so a
-                                server is not required to provide
-                                information the client is not
-                                authorized to see.''',
+        description=u'''The supportedlock property of a
+                        resource returns a listing of the
+                        combinations of scope and access types
+                        which may be specified in a lock
+                        request on the resource.  Note that
+                        the actual contents are themselves
+                        controlled by access controls so a
+                        server is not required to provide
+                        information the client is not
+                        authorized to see.''',
 
-                            readonly=True)
+        readonly=True)
 
 class IDAVSchema(IOptionalDAVSchema, IDAV2Schema):
     """Full DAV properties schema"""
@@ -216,7 +210,7 @@
 
 class IDAVWidget(IInputWidget):
     """A specialized widget used to convert to and from DAV properties."""
-    
+
     def __call__():
         """Render the widget.
 
@@ -227,7 +221,7 @@
         If a value should be a minidom DOM Node then use the XMLDAVWidget for
         inserting its value into the DAV XML response.
         """
-    
+
     def setRenderedValue(value):
         """Set the DAV value for the property
         """

Modified: Zope3/trunk/src/zope/app/dav/meta.zcml
===================================================================
--- Zope3/trunk/src/zope/app/dav/meta.zcml	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/dav/meta.zcml	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,11 +1,12 @@
-<configure 
+<configure
     xmlns="http://namespaces.zope.org/zope"
     xmlns:meta="http://namespaces.zope.org/meta">
 
-  <meta:directive 
+  <meta:directive
       namespace="http://namespaces.zope.org/dav"
       name="provideInterface"
       schema=".metadirectives.IProvideInterfaceDirective"
-      handler=".metaconfigure.interface"/>
+      handler=".metaconfigure.interface"
+      />
 
 </configure>

Modified: Zope3/trunk/src/zope/app/decorator.py
===================================================================
--- Zope3/trunk/src/zope/app/decorator.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/decorator.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -18,6 +18,8 @@
 
 $Id$
 """
+__docformat__ = "reStructuredText"
+
 from zope.proxy import getProxiedObject, ProxyBase
 from zope.security.checker import selectChecker, CombinedChecker
 from zope.security.proxy import Proxy, getChecker
@@ -93,18 +95,19 @@
       ...     b = 'b'
       ...     __Security_checker__ = DecoratedSecurityCheckerDescriptor()
 
-    Next we'll create and register a checker for Foo:
+    Next we'll create and register a checker for `Foo`:
 
       >>> from zope.security.checker import NamesChecker, defineChecker
       >>> fooChecker = NamesChecker(['a'])
       >>> defineChecker(Foo, fooChecker)
 
-    along with a checker for Wrapper:
+    along with a checker for `Wrapper`:
 
       >>> wrapperChecker = NamesChecker(['b'])
       >>> defineChecker(Wrapper, wrapperChecker)
 
-    Using selectChecker, we can confirm that a Foo object uses fooChecker:
+    Using `selectChecker()`, we can confirm that a `Foo` object uses
+    `fooChecker`:
 
       >>> foo = Foo()
       >>> selectChecker(foo) is fooChecker
@@ -114,7 +117,7 @@
       Traceback (most recent call last):
       ForbiddenAttribute: ('b', <zope.app.decorator.Foo object ...>)
 
-    and that a Wrapper object uses wrappeChecker:
+    and that a `Wrapper` object uses `wrappeChecker`:
 
       >>> wrapper = Wrapper(foo)
       >>> selectChecker(wrapper) is wrapperChecker
@@ -124,10 +127,10 @@
       Traceback (most recent call last):
       ForbiddenAttribute: ('a', <zope.app.decorator.Foo object ...>)
 
-    (Note that the object description says 'Foo' because the object is a
+    (Note that the object description says `Foo` because the object is a
     proxy and generally looks and acts like the object it's proxying.)
 
-    When we access wrapper's __Security_checker__ attribute, we invoke
+    When we access wrapper's ``__Security_checker__`` attribute, we invoke
     the decorated security checker descriptor. The decorator's job is to make
     sure checkers from both objects are used when available. In this case,
     because both objects have checkers, we get a combined checker:
@@ -139,7 +142,7 @@
       >>> checker.check(wrapper, 'b')
 
     The decorator checker will work even with security proxied objects. To
-    illustrate, we'll proxify foo:
+    illustrate, we'll proxify `foo`:
 
       >>> from zope.security.proxy import ProxyFactory
       >>> secure_foo = ProxyFactory(foo)
@@ -149,7 +152,7 @@
       Traceback (most recent call last):
       ForbiddenAttribute: ('b', <zope.app.decorator.Foo object ...>)
 
-    when we wrap the secured foo:
+    when we wrap the secured `foo`:
 
       >>> wrapper = Wrapper(secure_foo)
 
@@ -235,8 +238,7 @@
 
 
 class Decorator(ProxyBase):
-    """Decorator base class
-    """
+    """Decorator base class"""
 
     __providedBy__ = DecoratorSpecificationDescriptor()
     __Security_checker__ = DecoratedSecurityCheckerDescriptor()

Modified: Zope3/trunk/src/zope/app/demo/jobboard/job.py
===================================================================
--- Zope3/trunk/src/zope/app/demo/jobboard/job.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/demo/jobboard/job.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -23,7 +23,7 @@
 
 
 class Job(Persistent):
-    """ Job Class
+    """Job Class
 
     >>> myJob = Job(submitter='my name', summary='my summary',
     ...             description='my description',contact='my contact',
@@ -36,10 +36,8 @@
     >>> myJob.state
     'approved'
     """
-    
     implements(IJob)
-   
-        
+
     def __init__(self, submitter, summary, description,
                  contact, salary=None, startdate=None):
         self.submitter = submitter
@@ -63,7 +61,7 @@
 from persistent.dict import PersistentDict
 
 class JobList(Persistent):
-    """ the Joblist class manages the creation, deletion of job list and
+    """The Joblist class manages the creation, deletion of job list and
     can display the object ids which are in specific states
 
     >>> from job import Job
@@ -91,7 +89,6 @@
     """
     implements(IJobList)
 
-
     def __init__(self):
         self._lastid = 0
         self._jobs = PersistentDict()
@@ -131,8 +128,7 @@
 
     def getPendingIds(self):
         return self.query(JobState.PendingApproval)
-        
-        
+
     def allIds(self):
         return  self._jobs.items()
         #ids.sort()

Modified: Zope3/trunk/src/zope/app/exception/browser/configure.zcml
===================================================================
--- Zope3/trunk/src/zope/app/exception/browser/configure.zcml	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/exception/browser/configure.zcml	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,8 +1,8 @@
-<zope:configure 
+<zope:configure
    xmlns:zope="http://namespaces.zope.org/zope"
    xmlns="http://namespaces.zope.org/browser">
 
-  <page 
+  <page
       for="zope.interface.common.interfaces.IException"
       name="index.html"
       template="systemerror.pt"
@@ -15,7 +15,7 @@
       name="index.html"
       permission="zope.Public"
       template="unauthorized.pt"
-      class=".unauthorized.Unauthorized" 
+      class=".unauthorized.Unauthorized"
       />
 
   <page
@@ -23,7 +23,7 @@
       name="index.html"
       permission="zope.Public"
       template="user.pt"
-      class=".user.UserErrorView" 
+      class=".user.UserErrorView"
       />
 
   <page

Modified: Zope3/trunk/src/zope/app/form/browser/editview.py
===================================================================
--- Zope3/trunk/src/zope/app/form/browser/editview.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/form/browser/editview.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -65,7 +65,7 @@
 
     def _setUpWidgets(self):
         self.adapted = self.schema(self.context)
-        setUpEditWidgets(self, self.schema, source=self.adapted, 
+        setUpEditWidgets(self, self.schema, source=self.adapted,
                          names=self.fieldNames)
 
     def setPrefix(self, prefix):

Modified: Zope3/trunk/src/zope/app/form/browser/editwizard.py
===================================================================
--- Zope3/trunk/src/zope/app/form/browser/editwizard.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/form/browser/editwizard.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -179,9 +179,11 @@
         return not changed
 
     def renderHidden(self):
-        ''' Render state as hidden fields. Also render hidden fields to
-            propagate self.storage if we are not using the session to do this.
-        '''
+        """Render state as hidden fields.
+
+        Also render hidden fields to propagate self.storage if we are not
+        using the session to do this.
+        """
         olist = []
         out = olist.append
 

Modified: Zope3/trunk/src/zope/app/form/browser/objectwidget.py
===================================================================
--- Zope3/trunk/src/zope/app/form/browser/objectwidget.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/form/browser/objectwidget.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -30,32 +30,36 @@
 class ObjectWidgetView:
 
     template = ViewPageTemplateFile('objectwidget.pt')
-    
+
     def __init__(self, context, request):
         self.context = context
         self.request = request
-        
+
     def __call__(self):
         return self.template()
-    
-    
+
+
 class ObjectWidget(BrowserWidget, InputWidget):
     """A widget over an Interface that contains Fields.
 
-    "factory"  - factory used to create content that this widget (field)
-                 represents
-    *_widget   - Optional CustomWidgets used to generate widgets for the
-                 fields in this widget
+    ``factory``
+
+      factory used to create content that this widget (field) represents
+
+    ``*_widget``
+
+      Optional CustomWidgets used to generate widgets for the fields in this
+      widget
     """
 
     implements(IInputWidget)
-    
+
     _object = None      # the object value (from setRenderedValue & request)
     _request_parsed = False
 
     def __init__(self, context, request, factory, **kw):
         super(ObjectWidget, self).__init__(context, request)
-        
+
         # define view that renders the widget
         self.view = ObjectWidgetView(self, request)
 
@@ -79,18 +83,18 @@
     def _setUpEditWidgets(self):
         # subwidgets need a new name
         setUpWidgets(self, self.context.schema, IInputWidget,
-                         prefix=self.name, names=self.names, 
+                         prefix=self.name, names=self.names,
                          context=self.context)
 
     def __call__(self):
         return self.view()
-        
+
     def legendTitle(self):
         return self.context.title or self.context.__name__
 
     def getSubWidget(self, name):
         return getattr(self, '%s_widget' % name)
-            
+
     def subwidgets(self):
         return [self.getSubWidget(name) for name in self.names]
 
@@ -134,7 +138,7 @@
             field.set(content, value)
         # TODO: If value implements ILocation, set name to field name and
         # parent to content
-        
+
         return changes
 
     def hasInput(self):
@@ -157,5 +161,3 @@
         self._setUpEditWidgets()
         for name in self.names:
             self.getSubWidget(name).setRenderedValue(getattr(value, name, None))
-            
-

Modified: Zope3/trunk/src/zope/app/i18n/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/i18n/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/i18n/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -73,23 +73,23 @@
 
 class ISyncTranslationDomain(Interface):
     """This interface allows translation domains to be synchronized. The
-       following four synchronization states can exist::
+    following four synchronization states can exist:
 
-       0 - uptodate: The two messages are in sync.
-                Default Action: Do nothing.
+    0 - uptodate: The two messages are in sync.
+             Default Action: Do nothing.
 
-       1 - new: The message exists on the foreign TS, but is locally unknown.
-                Default Action: Add the message to the local catalog.
+    1 - new: The message exists on the foreign TS, but is locally unknown.
+             Default Action: Add the message to the local catalog.
 
-       2 - older: The local version of the message is older than the one on
-                the server.
-                Default Action: Update the local message.
+    2 - older: The local version of the message is older than the one on
+             the server.
+             Default Action: Update the local message.
 
-       3 - newer: The local version is newer than the foreign version.
-                Default Action: Do nothing.
+    3 - newer: The local version is newer than the foreign version.
+             Default Action: Do nothing.
 
-       4 - deleted: The message does not exist in the foreign TS.
-                Default Action: Delete local version of message/
+    4 - deleted: The message does not exist in the foreign TS.
+             Default Action: Delete local version of message.
     """
 
     def getMessagesMapping(languages, foreign_messages):

Modified: Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -65,13 +65,13 @@
         self.topic = None
 
     def getContextualTopicView(self):
-        """ retrieve and render the source of a context help topic """
+        """Retrieve and render the source of a context help topic """
         topic = self.getContextHelpTopic()
         view = zapi.getMultiAdapter((topic, self.request), name='index.html')
         return view.renderTopic()
 
     def getContextHelpTopic(self):
-        """ Retrieve a help topic based on the context of the
+        """Retrieve a help topic based on the context of the
         help namespace.
 
         If the context is a view, try to find
@@ -83,7 +83,6 @@
         based on the context.
 
         If nothing is found, return the onlinehelp root topic
-
         """
         if self.topic is not None:
             return self.topic

Modified: Zope3/trunk/src/zope/app/onlinehelp/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/onlinehelp/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -24,14 +24,14 @@
 from zope.app.container.interfaces import IContainer
 from zope.app.publication.interfaces import IFileContent
 from zope.app.file.interfaces import IFile
-from zope.app.i18n import ZopeMessageFactory as _ 
+from zope.app.i18n import ZopeMessageFactory as _
 
 class IOnlineHelpTopic(IContainer):
     """A Topic is a single help page that you can view. Topics are able to
     contain other Topics and so on.
 
     You can also associate a Topic with a particular view.
-    
+
     The Topic's content can be in the following four formats:
      - Plain Text,
      - HTML,
@@ -40,13 +40,13 @@
 
     The Content is stored in a file and not the Topic itself.
     The file is only read when required.
-    
+
     Note that all the Sub-Topic management is done via the utility service.
     The topic itself is stored in the IContainer implementation after add
-    the right parent topic of a child. This mechanism ensures that we don't 
-    have to take care on the registration order. 
-    The topic resources are stroed in the `IContainer` implementation of 
-    the topic too. 
+    the right parent topic of a child. This mechanism ensures that we don't
+    have to take care on the registration order.
+    The topic resources are stroed in the `IContainer` implementation of
+    the topic too.
     """
 
     id = TextLine(
@@ -87,13 +87,15 @@
         required = True)
 
     def addResources(resources):
-        """ Add resources to this Help Topic.
+        """Add resources to this Help Topic.
+
         The resources must be located in the same directory
-        as the Help Topic itself."""
+        as the Help Topic itself.
+        """
 
     def getTopicPath():
-        """ return the presumed path to the topic, even the topic is not
-        traversable from the onlinehelp. """
+        """Return the presumed path to the topic, even the topic is not
+        traversable from the onlinehelp."""
 
     def getSubTopics():
         """Returns IOnlineHelpTopic provided childs."""
@@ -131,37 +133,38 @@
 
 class IOnlineHelp(ISourceTextOnlineHelpTopic):
     """The root of an onlinehelp hierarchy.
+
     Manages the registration of new topics.
     """
 
-    def registerHelpTopic(parent_path, id, title, doc_path,  
+    def registerHelpTopic(parent_path, id, title, doc_path,
                           interface=None, view=None, resources=None):
         """This method registers a topic at the correct place.
 
-           `parent_path` -- Location of this topic's parent in the OnlineHelp
-           tree. Need not to exist at time of creation. 
+        `parent_path` -- Location of this topic's parent in the OnlineHelp
+        tree. Need not to exist at time of creation.
 
-           `id` -- Specifies the id of the topic 
+        `id` -- Specifies the id of the topic
 
-           `title` -- Specifies title of the topic. This title will be used in
-           the tree as Identification.
+        `title` -- Specifies title of the topic. This title will be used in
+        the tree as Identification.
 
-           `doc_path` -- Specifies where the file that contains the topic
-           content is located.
+        `doc_path` -- Specifies where the file that contains the topic content
+        is located.
 
-           `interface` -- Name of the interface for which the help topic is
-           being registered. This can be optional, since not all topics must
-           be bound to a particular interface.
+        `interface` -- Name of the interface for which the help topic is being
+        registered. This can be optional, since not all topics must be bound
+        to a particular interface.
 
-           `view` -- This attribute specifies the name of the view for which
-           this topic is registered. Note that this attribute is also
-           optional.
+        `view` -- This attribute specifies the name of the view for which this
+        topic is registered. Note that this attribute is also optional.
 
-           `resources` -- Specifies a list of resources for the topic,
-           for example images that are included by the rendered topic content.
-           Optional.
+        `resources` -- Specifies a list of resources for the topic, for
+        example images that are included by the rendered topic content.
+        Optional.
         """
 
+
 class IOnlineHelpResource(IFile, IFileContent):
     """A resource, which can be used in a help topic """
 

Modified: Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -11,7 +11,7 @@
 # FOR A PARTICULAR PURPOSE.
 #
 ##############################################################################
-"""Schemas for the ``help`` ZCML namespace 
+"""Schemas for the ``help`` ZCML namespace
 
 $Id$
 """
@@ -64,13 +64,14 @@
 
     class_ = GlobalObject(
         title=u"Factory",
-        description=u"The factory is the topic class used for initializeing the topic",
+        description=u"""
+        The factory is the topic class used for initializeing the topic""",
         required=False,
         )
 
     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.

Modified: Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -50,7 +50,6 @@
     >>> resource._fileMode
     'rb'
 
-    
     >>> path = os.path.join(testdir(), 'help2.txt')
 
     >>> resource = OnlineHelpResource(path)
@@ -58,7 +57,6 @@
     'text/plain'
     >>> resource._fileMode
     'r'
-    
     """
     implements(IOnlineHelpResource)
 
@@ -89,34 +87,35 @@
 
 
 class BaseOnlineHelpTopic(SampleContainer):
-    """
-    Base class for custom Help Topic implementations.
-    
-    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
-    >>> path = os.path.join(testdir(), 'help.txt')
+    """Base class for custom Help Topic implementations.
 
+      >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+      >>> path = os.path.join(testdir(), 'help.txt')
+
     Create a Help Topic from a file
-    
-    >>> topic = BaseOnlineHelpTopic('help','Help',path,'')
 
+      >>> topic = BaseOnlineHelpTopic('help','Help',path,'')
+
     Test the title
-    
-    >>> topic.title
-    'Help'
 
+      >>> topic.title
+      'Help'
+
     Test the topic path
-    >>> topic.getTopicPath()
-    'help'
-    >>> topic.parentPath = 'parent'
-    >>> topic.getTopicPath()
-    'parent/help'
 
+      >>> topic.getTopicPath()
+      'help'
+      >>> topic.parentPath = 'parent'
+      >>> topic.getTopicPath()
+      'parent/help'
+
     Resources can be added to an online help topic.
-    >>> topic.addResources(['test1.png', 'test2.png'])
-    >>> topic['test1.png'].contentType
-    'image/png'
-    >>> topic['test2.png'].contentType
-    'image/png'
+
+      >>> topic.addResources(['test1.png', 'test2.png'])
+      >>> topic['test1.png'].contentType
+      'image/png'
+      >>> topic['test2.png'].contentType
+      'image/png'
     """
 
     id = u""
@@ -125,7 +124,7 @@
     parentPath = u""
     interface = None
     view = None
-    
+
     def __init__(self, id, title, path, parentPath, interface=None, view=None):
         """Initialize object."""
         self.id = id
@@ -151,7 +150,7 @@
                 self[resource] = OnlineHelpResource(resource_path)
 
     def getTopicPath(self):
-        """ see IOnlineHelpTopic """
+        """See IOnlineHelpTopic"""
         if self.parentPath:
             return self.parentPath+'/'+self.id
         else:
@@ -162,7 +161,7 @@
         for item in self.values():
             if IOnlineHelpTopic.providedBy(item):
                 res.append(item)
-        
+
         return res
 
 
@@ -181,75 +180,81 @@
     """
     Represents a Help Topic. This generic implementation uses the filename
     extension for guess the type. This topic implementation supports plain
-    text topics, restructured and structured text topics. HTML topics get 
-    rendered as structured text. If a file doesn't have the right file 
+    text topics, restructured and structured text topics. HTML topics get
+    rendered as structured text. If a file doesn't have the right file
     extension, use a explicit topic class for representing the right format.
-    
-    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
-    >>> path = os.path.join(testdir(), 'help.txt')
 
+      >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+      >>> path = os.path.join(testdir(), 'help.txt')
+
     Create a Help Topic from a file
-    
-    >>> topic = OnlineHelpTopic('help','Help',path,'')
 
+      >>> topic = OnlineHelpTopic('help','Help',path,'')
+
     Test the title
-    
-    >>> topic.title
-    'Help'
 
+      >>> topic.title
+      'Help'
+
     Test the topic path
-    >>> topic.getTopicPath()
-    'help'
-    >>> topic.parentPath = 'parent'
-    >>> topic.getTopicPath()
-    'parent/help'
 
+      >>> topic.getTopicPath()
+      'help'
+      >>> topic.parentPath = 'parent'
+      >>> topic.getTopicPath()
+      'parent/help'
+
     The type should be set to plaintext, since
     the file extension is 'txt'
-    
-    >>> topic.type
-    'zope.source.plaintext'
 
+      >>> topic.type
+      'zope.source.plaintext'
+
     Test the help content.
 
-    >>> topic.source
-    'This is a help!'
+      >>> topic.source
+      'This is a help!'
 
-    >>> path = os.path.join(testdir(), 'help.stx')
-    >>> topic = OnlineHelpTopic('help','Help',path,'')
+      >>> path = os.path.join(testdir(), 'help.stx')
+      >>> topic = OnlineHelpTopic('help','Help',path,'')
 
     The type should now be structured text
-    >>> topic.type
-    'zope.source.stx'
 
+      >>> topic.type
+      'zope.source.stx'
+
     HTML files are treated as structured text files
-    >>> path = os.path.join(testdir(), 'help.html')
-    >>> topic = OnlineHelpTopic('help','Help',path,'')
 
+      >>> path = os.path.join(testdir(), 'help.html')
+      >>> topic = OnlineHelpTopic('help','Help',path,'')
+
     The type should still be structured text
-    >>> topic.type
-    'zope.source.stx'
 
-    >>> path = os.path.join(testdir(), 'help.rst')
-    >>> topic = OnlineHelpTopic('help','Help',path,'')
+      >>> topic.type
+      'zope.source.stx'
 
+      >>> path = os.path.join(testdir(), 'help.rst')
+      >>> topic = OnlineHelpTopic('help','Help',path,'')
+
     The type should now be restructured text
-    >>> topic.type
-    'zope.source.rest'
 
+      >>> topic.type
+      'zope.source.rest'
+
     Resources can be added to an online help topic.
-    >>> topic.addResources(['test1.png', 'test2.png'])
-    >>> topic['test1.png'].contentType
-    'image/png'
-    >>> topic['test2.png'].contentType
-    'image/png'
+
+      >>> topic.addResources(['test1.png', 'test2.png'])
+      >>> topic['test1.png'].contentType
+      'image/png'
+      >>> topic['test2.png'].contentType
+      'image/png'
     """
 
     implements(ISourceTextOnlineHelpTopic)
 
     def __init__(self, id, title, path, parentPath, interface=None, view=None):
         """Initialize object."""
-        super(OnlineHelpTopic, self).__init__(id, title, path, parentPath, 
+        super(OnlineHelpTopic, self).__init__(id, title, path, parentPath,
               interface, view)
 
         filename = os.path.basename(path.lower())
@@ -267,163 +272,168 @@
 
 class RESTOnlineHelpTopic(SourceTextOnlineHelpTopic):
     """
-    Represents a restructed text based Help Topic which has other 
+    Represents a restructed text based Help Topic which has other
     filename extension then '.rst' or 'rest'.
-    
-    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
-    >>> path = os.path.join(testdir(), 'help.rst')
 
+      >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+      >>> path = os.path.join(testdir(), 'help.rst')
+
     Create a Help Topic from a file
-    
-    >>> topic = RESTOnlineHelpTopic('help','Help',path,'')
 
+      >>> topic = RESTOnlineHelpTopic('help','Help',path,'')
+
     Test the title
-    
-    >>> topic.title
-    'Help'
 
+      >>> topic.title
+      'Help'
+
     Test the topic path
-    >>> topic.getTopicPath()
-    'help'
-    >>> topic.parentPath = 'parent'
-    >>> topic.getTopicPath()
-    'parent/help'
 
+      >>> topic.getTopicPath()
+      'help'
+      >>> topic.parentPath = 'parent'
+      >>> topic.getTopicPath()
+      'parent/help'
+
     The type should be set to rest, since the file extension is 'rest'
-    
-    >>> topic.type
-    'zope.source.rest'
 
+      >>> topic.type
+      'zope.source.rest'
+
     Test the help content.
 
-    >>> topic.source
-    'This is a ReST help!'
+      >>> topic.source
+      'This is a ReST help!'
 
     Resources can be added to an online help topic.
-    >>> topic.addResources(['test1.png', 'test2.png'])
-    >>> topic['test1.png'].contentType
-    'image/png'
-    >>> topic['test2.png'].contentType
-    'image/png'
+
+      >>> topic.addResources(['test1.png', 'test2.png'])
+      >>> topic['test1.png'].contentType
+      'image/png'
+      >>> topic['test2.png'].contentType
+      'image/png'
     """
 
     implements(IRESTOnlineHelpTopic)
 
     type = 'zope.source.rest'
-    
+
     def __init__(self, id, title, path, parentPath, interface=None, view=None):
         """Initialize object."""
-        super(RESTOnlineHelpTopic, self).__init__(id, title, path, parentPath, 
+        super(RESTOnlineHelpTopic, self).__init__(id, title, path, parentPath,
               interface, view)
 
 
 class STXOnlineHelpTopic(SourceTextOnlineHelpTopic):
     """
-    Represents a restructed text based Help Topic which has other 
+    Represents a restructed text based Help Topic which has other
     filename extension then '.stx'.
-    
-    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
-    >>> path = os.path.join(testdir(), 'help.stx')
 
+      >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+      >>> path = os.path.join(testdir(), 'help.stx')
+
     Create a Help Topic from a file
-    
-    >>> topic = STXOnlineHelpTopic('help','Help',path,'')
 
+      >>> topic = STXOnlineHelpTopic('help','Help',path,'')
+
     Test the title
-    
-    >>> topic.title
-    'Help'
 
+      >>> topic.title
+      'Help'
+
     Test the topic path
-    >>> topic.getTopicPath()
-    'help'
-    >>> topic.parentPath = 'parent'
-    >>> topic.getTopicPath()
-    'parent/help'
 
+      >>> topic.getTopicPath()
+      'help'
+      >>> topic.parentPath = 'parent'
+      >>> topic.getTopicPath()
+      'parent/help'
+
     The type should be set to stx, since the file extension is 'stx'
-    
-    >>> topic.type
-    'zope.source.stx'
 
+      >>> topic.type
+      'zope.source.stx'
+
     Test the help content.
 
-    >>> topic.source
-    'This is a STX help!'
+      >>> topic.source
+      'This is a STX help!'
 
     Resources can be added to an online help topic.
-    >>> topic.addResources(['test1.png', 'test2.png'])
-    >>> topic['test1.png'].contentType
-    'image/png'
-    >>> topic['test2.png'].contentType
-    'image/png'
+
+      >>> topic.addResources(['test1.png', 'test2.png'])
+      >>> topic['test1.png'].contentType
+      'image/png'
+      >>> topic['test2.png'].contentType
+      'image/png'
     """
 
     implements(ISTXOnlineHelpTopic)
-    
+
     type = 'zope.source.stx'
-    
+
     def __init__(self, id, title, path, parentPath, interface=None, view=None):
         """Initialize object."""
-        super(STXOnlineHelpTopic, self).__init__(id, title, path, parentPath, 
+        super(STXOnlineHelpTopic, self).__init__(id, title, path, parentPath,
               interface, view)
 
 
 class ZPTOnlineHelpTopic(BaseOnlineHelpTopic):
     """
-    Represents a page template based Help Topic which has other 
+    Represents a page template based Help Topic which has other
     filename extension then '.pt'.
-    
-    
-    >>> from zope.publisher.browser import TestRequest
-    >>> from zope.app.publisher.browser import BrowserView
-    >>> from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
-    >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
-    >>> path = os.path.join(testdir(), 'help.pt')
 
+      >>> from zope.publisher.browser import TestRequest
+      >>> from zope.app.publisher.browser import BrowserView
+      >>> from zope.app.pagetemplate.viewpagetemplatefile import \
+      ...     ViewPageTemplateFile
+      >>> from zope.app.onlinehelp.tests.test_onlinehelp import testdir
+      >>> path = os.path.join(testdir(), 'help.pt')
+
     Create a page template bsed Help Topic from a file
-    
-    >>> topic = ZPTOnlineHelpTopic('help','Help',path,'')
 
+      >>> topic = ZPTOnlineHelpTopic('help','Help',path,'')
+
     Test the title
-    
-    >>> topic.title
-    'Help'
 
+      >>> topic.title
+      'Help'
+
     Test the topic path
-    >>> topic.getTopicPath()
-    'help'
-    >>> topic.parentPath = 'parent'
-    >>> topic.getTopicPath()
-    'parent/help'
 
+      >>> topic.getTopicPath()
+      'help'
+      >>> topic.parentPath = 'parent'
+      >>> topic.getTopicPath()
+      'parent/help'
+
     Test the help content.
 
-    >>> class TestView(BrowserView):
-    ...     def index(self):
-    ...         path = self.context.path
-    ...         view = ViewPageTemplateFile(path)
-    ...         return view(self)
-    >>> request = TestRequest()
-    >>> view = TestView(topic, request)
-    >>> res = view.index()
-    >>> str(res).find('<body>This is a ZPT help!</body>') > 0
-    True
+      >>> class TestView(BrowserView):
+      ...     def index(self):
+      ...         path = self.context.path
+      ...         view = ViewPageTemplateFile(path)
+      ...         return view(self)
+      >>> request = TestRequest()
+      >>> view = TestView(topic, request)
+      >>> res = view.index()
+      >>> str(res).find('<body>This is a ZPT help!</body>') > 0
+      True
 
     Resources can be added to an online help topic.
 
-    >>> topic.addResources(['test1.png', 'test2.png'])
-    >>> topic['test1.png'].contentType
-    'image/png'
-    >>> topic['test2.png'].contentType
-    'image/png'
+      >>> topic.addResources(['test1.png', 'test2.png'])
+      >>> topic['test1.png'].contentType
+      'image/png'
+      >>> topic['test2.png'].contentType
+      'image/png'
     """
 
     implements(IZPTOnlineHelpTopic)
 
     def __init__(self, id, title, path, parentPath, interface=None, view=None):
         """Initialize object."""
-        super(ZPTOnlineHelpTopic, self).__init__(id, title, path, parentPath, 
+        super(ZPTOnlineHelpTopic, self).__init__(id, title, path, parentPath,
               interface, view)
 
 

Modified: Zope3/trunk/src/zope/app/pluggableauth/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/pluggableauth/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/pluggableauth/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -44,8 +44,7 @@
 
 
 class IPrincipalSource(Interface):
-    """A read-only source of `IPrincipals`.
-    """
+    """A read-only source of `IPrincipals`."""
 
     def getPrincipal(id):
         """Get principal meta-data.
@@ -81,7 +80,7 @@
     def __setitem__(id, principal_source):
         """Add to object"""
     __setitem__.precondition = ItemTypePrecondition(IPrincipalSource)
-  
+
     def removePrincipalSource(id):
         """Remove a `PrincipalSource`.
 
@@ -90,11 +89,11 @@
 
 
 class ILoginPasswordPrincipalSource(IPrincipalSource):
-    """ A principal source which can authenticate a user given a
+    """A principal source which can authenticate a user given a
     login and a password """
 
     def authenticate(login, password):
-        """ Return a principal matching the login/password pair.
+        """Return a principal matching the login/password pair.
 
         If there is no principal in this principal source which
         matches the login/password pair, return ``None``.
@@ -109,8 +108,8 @@
 class IContainerPrincipalSource(IContainer):
     """This is a marker interface for specifying principal sources that are
     also containers. """
-    
 
+
 class IContainedPrincipalSource(IPrincipalSource, IContained):
     """This is a marker interface for principal sources that can be directly
     added to an authentication utility. It ensures that principal source can

Modified: Zope3/trunk/src/zope/app/publication/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/publication/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -73,13 +73,13 @@
     """XMLRPC request factory"""
 
 class IBrowserRequestFactory(IRequestFactory):
-    """browser request factory"""
+    """Browser request factory"""
 
 class IFileContent(interface.Interface):
     """Marker interface for content that can be managed as files.
 
     The default view for file content has effective URLs that don't end in
-    /.  In particular, if the content included HTML, relative links in
+    `/`.  In particular, if the content included HTML, relative links in
     the HTML are relative to the container the content is in.
     """
 
@@ -88,32 +88,33 @@
     """ request-publication factory """
 
     def canHandle(environment):
-        """ returns True if it can handle the request,
-            otherwise False. 'environment' can be used by the factory 
-            to make a decision based on the HTTP headers.
+        """Return ``True`` if it can handle the request, otherwise ``False``.
+
+        `environment` can be used by the factory to make a decision based on
+        the HTTP headers.
         """
 
     def __call__():
-        """ returns a tuple (request, publication) """
+        """Return a tuple (request, publication)"""
 
 class IRequestPublicationRegistry(interface.Interface):
-    """ A registry to lookup a RequestPublicationFactory by
-        request method + mime-type. Multiple factories can be configured
-        for the same method+mimetype. The factory itself can introspect
-        the environment to decide if it can handle the request as given
-        by the environment or not. Factories are sorted in the order
-        of their registration in ZCML.
+    """A registry to lookup a RequestPublicationFactory by
+       request method + mime-type. Multiple factories can be configured
+       for the same method+mimetype. The factory itself can introspect
+       the environment to decide if it can handle the request as given
+       by the environment or not. Factories are sorted in the order
+       of their registration in ZCML.
     """
 
     def register(method, mimetype, name, priority, factory):
-        """ registers a factory for method+mimetype """
+        """Registers a factory for method+mimetype."""
 
     def lookup(method, mimetype, environment):
-        """ Lookup a factory for a given method+mimetype and a 
-            environment. 
+        """Lookup a factory for a given method+mimetype and a
+        environment.
         """
 
     def getFactoriesFor(method, mimetype):
-        """ return the internal datastructure representing the configured
-            factories (basically for testing, not for introspection)
+        """Return the internal datastructure representing the configured
+        factories (basically for testing, not for introspection).
         """

Modified: Zope3/trunk/src/zope/app/publication/requestpublicationregistry.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/requestpublicationregistry.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/publication/requestpublicationregistry.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -23,16 +23,18 @@
 from zope.configuration.exceptions import ConfigurationError
 
 class RequestPublicationRegistry(object):
-    """ The registry implements a three stage lookup for registred factories
-        that have to deal with requests.
-        {method > { mimetype -> [{'priority' : some_int,
-                                   'factory' :  factory,
-                                   'name' : some_name }, ...
-                                  ]
-                    },
-        }
-        The 'priority' is used to define a lookup-order when multiple
-        factories are registered for the same method and mime-type.
+    """The registry implements a three stage lookup for registred factories
+    that have to deal with requests::
+
+      {method > { mimetype -> [{'priority' : some_int,
+                                 'factory' :  factory,
+                                 'name' : some_name }, ...
+                                ]
+                  },
+      }
+
+    The `priority` is used to define a lookup-order when multiple factories
+    are registered for the same method and mime-type.
     """
     implements(IRequestPublicationRegistry)
 
@@ -40,7 +42,7 @@
         self._d = {}   # method -> { mimetype -> {factories_data}}
 
     def register(self, method, mimetype, name, priority, factory):
-        """registers a factory for method+mimetype """
+        """Register a factory for method+mimetype """
 
         # initialize the two-level deep nested datastructure if necessary
         if not self._d.has_key(method):
@@ -74,7 +76,7 @@
     def getFactoriesFor(self, method, mimetype):
 
         if ';' in mimetype:
-            # 'mimetype' might be something like 'text/xml; charset=utf8'. In 
+            # `mimetype` might be something like 'text/xml; charset=utf8'. In
             # this case we are only interested in the first part.
             mimetype = mimetype.split(';')[0]
 
@@ -85,9 +87,7 @@
 
 
     def lookup(self, method, mimetype, environment):
-        """ Lookup a factory for a given method+mimetype and a
-            environment.
-        """
+        """Lookup a factory for a given method+mimetype and a environment."""
 
         for m,mt in ((method, mimetype), (method, '*'), ('*', '*')):
             factory_lst = self.getFactoriesFor(m, mt)

Modified: Zope3/trunk/src/zope/app/publisher/xmlrpc/README.txt
===================================================================
--- Zope3/trunk/src/zope/app/publisher/xmlrpc/README.txt	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/publisher/xmlrpc/README.txt	2005-10-30 20:16:09 UTC (rev 39752)
@@ -122,7 +122,7 @@
   <BLANKLINE>
 
 Named XML-RPC Views
-------------------
+-------------------
 
 Now let's look at views that have their own methods or other
 subobjects.  Views that have their own methods have names that appear

Modified: Zope3/trunk/src/zope/app/pythonpage/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/pythonpage/__init__.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/pythonpage/__init__.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
+
 import re
 from persistent import Persistent
 from zope.app import zapi
@@ -49,8 +51,8 @@
     def __call__(request, **kw):
         """Execute the script.
 
-        The script will insert the 'request' and all '**kw' as global
-        variables. Furthermore, the variables 'script' and 'context' (which is
+        The script will insert the `request` and all `**kw` as global
+        variables. Furthermore, the variables `script` and `context` (which is
         the container of the script) will be added.
         """
 
@@ -58,7 +60,7 @@
 class PythonPage(Contained, Persistent):
     r"""Persistent Python Page - Content Type
 
-    Examples::
+    Examples:
 
       >>> from tests import Root
 
@@ -183,7 +185,7 @@
         # compile() don't accept '\r' altogether
         source = source.replace("\r\n", "\n")
         source = source.replace("\r", "\n")
-        
+
         if isinstance(source, unicode):
 
             # Use special conversion function to work around
@@ -226,6 +228,3 @@
     if raw:
         return match.group(1)+'print '+`string`
     return match.group(1)+'print u'+match.group(3).encode('unicode-escape')
-
-    
-    

Modified: Zope3/trunk/src/zope/app/rdb/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/rdb/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/rdb/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -199,7 +199,7 @@
         """
 
     def fetchall():
-        """ Fetch all (remaining) rows of a query result, returning them as a
+        """Fetch all (remaining) rows of a query result, returning them as a
         sequence of sequences (e.g. a list of tuples). Note that the cursor's
         arraysize attribute can affect the performance of this operation.
 

Modified: Zope3/trunk/src/zope/app/session/session.py
===================================================================
--- Zope3/trunk/src/zope/app/session/session.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/session/session.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -332,7 +332,7 @@
 
 class SessionData(Persistent, IterableUserDict):
     """See zope.app.session.interfaces.ISessionData
-    
+
         >>> session = SessionData()
         >>> ISessionData.providedBy(session)
         True

Modified: Zope3/trunk/src/zope/app/twisted/http.py
===================================================================
--- Zope3/trunk/src/zope/app/twisted/http.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/twisted/http.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -31,7 +31,7 @@
     resource = twisted.web2.wsgi.WSGIResource(
         wsgi.WSGIPublisherApplication(db))
     resource = twisted.web2.log.LogWrapperResource(resource)
-    
+
     return HTTPFactory(twisted.web2.server.Site(resource))
 
 
@@ -44,7 +44,7 @@
     resource = twisted.web2.wsgi.WSGIResource(
         wsgi.PMDBWSGIPublisherApplication(db))
     resource = twisted.web2.log.LogWrapperResource(resource)
-    
+
     return HTTPFactory(twisted.web2.server.Site(resource))
 
 pmhttp = ServerType(createPMHTTPFactory, 8080)

Modified: Zope3/trunk/src/zope/app/workflow/stateful/browser/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/workflow/stateful/browser/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/app/workflow/stateful/browser/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -15,6 +15,7 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope.interface import Interface
 
 class IContentFilterAdapter(Interface):
@@ -22,10 +23,18 @@
     def filterListByState(objList, state, workflow='default'):
         """Filter a list of objects according to given workflow and state
 
-        objList  ... list of objects
-        state    ... name of a state (of the given workflow) in which the result
-                      objects must be
-        workflow ... name of a workflow to which result objects must be attached
+        ``objList``
+
+          list of objects
+
+        ``state``
+
+          name of a state (of the given workflow) in which the result objects
+          must be
+
+        ``workflow``
+
+          name of a workflow to which result objects must be attached
         """
 
     def filterObjectByState(object, state, workflow='default'):

Modified: Zope3/trunk/src/zope/component/bbb/adapter.py
===================================================================
--- Zope3/trunk/src/zope/component/bbb/adapter.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/component/bbb/adapter.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -15,6 +15,8 @@
 
 $Id$
 """
+__docformat__ = "reStructuredText"
+
 import sys
 import warnings
 from types import ClassType
@@ -33,7 +35,7 @@
 
         :Parameters:
           - `required`: a sequence of specifications for objects to be
-             adapted. 
+             adapted.
           - `provided`: The interface provided by the adapter
           - `name`: The adapter name
           - `factory`: The object used to compute the adapter
@@ -45,7 +47,7 @@
 
         :Parameters:
           - `required`: a sequence of specifications for objects to be
-             adapted. 
+             adapted.
           - `provided`: The interface provided by the adapter
           - `name`: The adapter name
           - `factory`: The object used to compute the subscriber
@@ -54,7 +56,7 @@
 
 class AdapterService(object):
     """Base implementation of an adapter service, implementing only the
-    'IAdapterService' interface.
+    `IAdapterService` interface.
 
     No write-methods were implemented.
     """

Modified: Zope3/trunk/src/zope/configuration/xmlconfig.py
===================================================================
--- Zope3/trunk/src/zope/configuration/xmlconfig.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/configuration/xmlconfig.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -20,6 +20,7 @@
 $Id$
 """
 __docformat__ = 'restructuredtext'
+
 import errno
 import os
 import sys
@@ -420,7 +421,7 @@
 
     files = schema.BytesLine(
         title=u"Configuration file name pattern",
-        description=u"""\
+        description=u"""
         The names of multiple configuration files to be included,
         expressed as a file-name pattern, relative to the directive
         containing the including configuration file.  The pattern can
@@ -442,9 +443,9 @@
 
     package = config.fields.GlobalObject(
         title=u"Include package",
-        description=u"""\
-        Include the named file (or configure.zcml)
-        from the directory of this package.
+        description=u"""
+        Include the named file (or configure.zcml) from the directory of this
+        package.
         """,
         required=False,
         )

Modified: Zope3/trunk/src/zope/i18n/interfaces/__init__.py
===================================================================
--- Zope3/trunk/src/zope/i18n/interfaces/__init__.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/i18n/interfaces/__init__.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -106,7 +106,7 @@
     The domain is used to specify which translation to use.  Different
     products will often use a specific domain naming translations supplied
     with the product.
-    
+
     A favorite example is: How do you translate 'Sun'? Is it our star, the
     abbreviation of Sunday or the company?  Specifying the domain, such as
     'Stars' or 'DaysOfWeek' will solve this problem for us.

Modified: Zope3/trunk/src/zope/interface/common/sequence.py
===================================================================
--- Zope3/trunk/src/zope/interface/common/sequence.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/interface/common/sequence.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -15,135 +15,138 @@
 
 $Id$
 """
+__docformat__ = 'restructuredtext'
 from zope import interface
 
 class IMinimalSequence(interface.Interface):
-    
+
     def __getitem__(index):
-        """x.__getitem__(index) <==> x[index]
-        
-        Declaring this interface does not specify whether __getitem__
+        """`x.__getitem__(index)` <==> `x[index]`
+
+        Declaring this interface does not specify whether `__getitem__`
         supports slice objects."""
 
     def __iter__():
-        "x.__iter__() <==> iter(x)"
+        """`x.__iter__()` <==> `iter(x)`"""
 
 class IFiniteSequence(IMinimalSequence):
 
     def __len__():
-        "x.__len__() <==> len(x)"
+        """`x.__len__()` <==> `len(x)`"""
 
 class IReadSequence(IFiniteSequence):
-    "read interface shared by tuple and list"
+    """read interface shared by tuple and list"""
 
     def __contains__(item):
-        "x.__contains__(item) <==> item in x"
+        """`x.__contains__(item)` <==> `item in x`"""
 
     def __lt__(other):
-        "x.__lt__(other) <==> x<other"
+        """`x.__lt__(other)` <==> `x < other`"""
 
     def __le__(other):
-        "x.__le__(other) <==> x<=other"
+        """`x.__le__(other)` <==> `x <= other`"""
 
     def __eq__(other):
-        "x.__eq__(other) <==> x==other"
+        """`x.__eq__(other)` <==> `x == other`"""
 
     def __ne__(other):
-        "x.__ne__(other) <==> x!=other"
+        """`x.__ne__(other)` <==> `x != other`"""
 
     def __gt__(other):
-        "x.__gt__(other) <==> x>other"
+        """`x.__gt__(other)` <==> `x > other`"""
 
     def __ge__(other):
-        "x.__ge__(other) <==> x>=other"
+        """`x.__ge__(other)` <==> `x >= other`"""
 
     def __add__(other):
-        "x.__add__(other) <==> x+other"
+        """`x.__add__(other)` <==> `x + other`"""
 
     def __mul__(n):
-        "x.__mul__(n) <==> x*n"
+        """`x.__mul__(n)` <==> `x * n`"""
 
     def __rmul__(n):
-        "x.__rmul__(n) <==> n*x"
-    
+        """`x.__rmul__(n)` <==> `n * x`"""
+
     def __getslice__(i, j):
-        """x.__getslice__(i, j) <==> x[i:j]
+        """`x.__getslice__(i, j)` <==> `x[i:j]`
 
         Use of negative indices is not supported.
-        
-        Deprecated since Python 2.0 but still a part of UserList.
+
+        Deprecated since Python 2.0 but still a part of `UserList`.
         """
 
 class IExtendedReadSequence(IReadSequence):
-    "Full read interface for lists"
+    """Full read interface for lists"""
 
     def count(item):
-        "return number of occurrences of value"
+        """Return number of occurrences of value"""
 
     def index(item, *args):
-        """return first index of value
+        """Return first index of value
 
-        L.index(value, [start, [stop]]) -> integer"""
+        `L.index(value, [start, [stop]])` -> integer"""
 
 class IUniqueMemberWriteSequence(interface.Interface):
-    "The write contract for a sequence that may enforce unique members"
+    """The write contract for a sequence that may enforce unique members"""
 
     def __setitem__(index, item):
-        """x.__setitem__(index, item) <==> x[index]=item
-        
-        Declaring this interface does not specify whether __setitem__
-        supports slice objects."""
+        """`x.__setitem__(index, item)` <==> `x[index] = item`
 
+        Declaring this interface does not specify whether `__setitem__`
+        supports slice objects.
+        """
+
     def __delitem__(index):
-        """x.__delitem__(index) <==> del x[index]
-        
-        Declaring this interface does not specify whether __delitem__
-        supports slice objects."""
+        """`x.__delitem__(index)` <==> `del x[index]`
 
+        Declaring this interface does not specify whether `__delitem__`
+        supports slice objects.
+        """
+
     def __setslice__(i, j, other):
-        """x.__setslice__(i, j, other) <==> x[i:j]=other
+        """`x.__setslice__(i, j, other)` <==> `x[i:j]=other`
 
-        Use  of negative indices is not supported.
-        
-        Deprecated since Python 2.0 but still a part of UserList.
+        Use of negative indices is not supported.
+
+        Deprecated since Python 2.0 but still a part of `UserList`.
         """
 
     def __delslice__(i, j):
-        """x.__delslice__(i, j) <==> del x[i:j]
+        """`x.__delslice__(i, j)` <==> `del x[i:j]`
 
         Use of negative indices is not supported.
-        
-        Deprecated since Python 2.0 but still a part of UserList.
+
+        Deprecated since Python 2.0 but still a part of `UserList`.
         """
     def __iadd__(y):
-        "x.__iadd__(y) <==> x+=y"
+        """`x.__iadd__(y)` <==> `x += y`"""
 
     def append(item):
-        "append item to end"
+        """Append item to end"""
 
     def insert(index, item):
-        "insert item before index"
+        """Insert item before index"""
 
     def pop(index=-1):
-        "remove and return item at index (default last)"
+        """Remove and return item at index (default last)"""
 
     def remove(item):
-        "remove first occurrence of value"
+        """Remove first occurrence of value"""
 
     def reverse():
-        "reverse *IN PLACE*"
+        """Reverse *IN PLACE*"""
 
     def sort(cmpfunc=None):
-        """stable sort *IN PLACE*; cmpfunc(x, y) -> -1, 0, 1"""
+        """Stable sort *IN PLACE*; `cmpfunc(x, y)` -> -1, 0, 1"""
 
     def extend(iterable):
-        "extend list by appending elements from the iterable"
+        """Extend list by appending elements from the iterable"""
 
 class IWriteSequence(IUniqueMemberWriteSequence):
-    "Full write contract for sequences"
+    """Full write contract for sequences"""
 
     def __imul__(n):
-        "x.__imul__(n) <==> x*=n"
+        """`x.__imul__(n)` <==> `x *= n`"""
 
 class ISequence(IReadSequence, IWriteSequence):
-    "Full sequence contract"
+    """Full sequence contract"""

Modified: Zope3/trunk/src/zope/interface/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/interface/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/interface/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -29,13 +29,13 @@
     __doc__  = Attribute('__doc__', 'The object doc string')
 
     def getTaggedValue(tag):
-        """Returns the value associated with 'tag'.
+        """Returns the value associated with `tag`.
 
-        Raise a KeyError of the tag isn't set
+        Raise a `KeyError` of the tag isn't set.
         """
 
     def queryTaggedValue(tag, default=None):
-        """Returns the value associated with 'tag'.
+        """Returns the value associated with `tag`.
 
         Return the default value of the tag isn't set.
         """
@@ -44,7 +44,7 @@
         """Returns a list of all tags."""
 
     def setTaggedValue(tag, value):
-        """Associates 'value' with 'key'."""
+        """Associates `value` with `key`."""
 
 
 class IAttribute(IElement):
@@ -56,8 +56,7 @@
 
 
 class IMethod(IAttribute):
-    """Method attributes
-    """
+    """Method attributes"""
 
     def getSignatureInfo():
         """Returns the signature information.
@@ -70,7 +69,7 @@
 
         o `optional` - A list of all optional arguments.
 
-        o `varargs' - The name of the varargs argument.
+        o `varargs` - The name of the varargs argument.
 
         o `kwargs` - The name of the kwargs argument.
         """
@@ -84,8 +83,7 @@
         """
 
 class ISpecification(Interface):
-    """Object Behavioral specifications
-    """
+    """Object Behavioral specifications"""
 
     def extends(other, strict=True):
         """Test whether a specification extends another
@@ -94,7 +92,6 @@
         interface or if one of it's bases extends other.
 
         If strict is false, then the specification extends itself.
-        
         """
 
     def isOrExtends(other):
@@ -133,7 +130,7 @@
         returned.
         """
 
-        
+
 class IInterface(ISpecification, IElement):
     """Interface objects
 
@@ -151,10 +148,10 @@
 
       o Descriptions of methods.  Method descriptions can include:
 
-        o Prose "doc string" documentation about the method and its
+        - Prose "doc string" documentation about the method and its
           usage.
 
-        o A description of the methods arguments; how many arguments
+        - A description of the methods arguments; how many arguments
           are expected, optional arguments and their default values,
           the position or arguments in the signature, whether the
           method accepts arbitrary arguments and whether the method
@@ -179,29 +176,25 @@
       from zope.interface import Interface
 
       class IMyInterface(Interface):
-        '''Interface documentation
-        '''
+        '''Interface documentation'''
 
         def meth(arg1, arg2):
-            '''Documentation for meth
-            '''
+            '''Documentation for meth'''
 
         # Note that there is no self argument
 
      class IMySubInterface(IMyInterface):
-        '''Interface documentation
-        '''
+        '''Interface documentation'''
 
         def meth2():
-            '''Documentation for meth2
-            '''
+            '''Documentation for meth2'''
 
     You use interfaces in two ways:
 
     o You assert that your object implement the interfaces.
 
       There are several ways that you can assert that an object
-      implements an interface::
+      implements an interface:
 
       1. Call zope.interface.implements in your class definition.
 
@@ -276,7 +269,7 @@
 
         If the interface doesn't define the name, returns None.
         """
-    
+
     def validateInvariants(obj, errors=None):
         """Validate invariants
 
@@ -302,7 +295,6 @@
 
     Declarations are used to express the interfaces implemented by
     classes or provided by objects.
-    
     """
 
     def __contains__(interface):
@@ -423,7 +415,6 @@
 
         A callable is returned that makes an implements declaration on
         objects passed to it.
-        
         """
 
     def classImplementsOnly(class_, *interfaces):
@@ -634,8 +625,7 @@
     No specific semantics are assumed for the registered objects,
     however, the most common application will be to register factories
     that adapt objects providing required specifications to a provided
-    interface. 
-    
+    interface.
     """
 
     def register(required, provided, name, value):
@@ -678,4 +668,3 @@
         Subscribers for a *sequence* of required interfaces, and a provided
         interface are returned.
         """
-    

Modified: Zope3/trunk/src/zope/schema/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/schema/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/schema/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -15,6 +15,7 @@
 
 $Id$
 """
+__docformat__ = "reStructuredText"
 
 from zope.interface import Interface, Attribute
 from zope.schema._bootstrapfields import Container, Iterable
@@ -136,7 +137,7 @@
 
     order = Int(
         title=_(u"Field Order"),
-        description=_(u"""\
+        description=_(u"""
         The order attribute can be used to determine the order in
         which fields in a schema were defined. If one field is created
         after another (in the same thread), its order will be
@@ -184,23 +185,23 @@
     u"""Fields with a value that can be iterated over.
 
     The value needs to support iteration; the implementation mechanism
-    is not constrained.  (Either __iter__() or __getitem__() may be
+    is not constrained.  (Either `__iter__()` or `__getitem__()` may be
     used.)
     """
 
 class IContainer(IField):
-    u"""Fields whose value allows an 'x in value' check.
+    u"""Fields whose value allows an ``x in value`` check.
 
-    The Value needs to support the 'in' operator, but is not
-    constrained in how it does so (whether it defines __contains__()
-    or __getitem__() is immaterial).
+    The value needs to support the `in` operator, but is not
+    constrained in how it does so (whether it defines `__contains__()`
+    or `__getitem__()` is immaterial).
     """
 
 class IOrderable(IField):
     u"""Field requiring its value to be orderable.
 
     The set of value needs support a complete ordering; the
-    implementation mechanism is not constrained.  Either __cmp__() or
+    implementation mechanism is not constrained.  Either `__cmp__()` or
     'rich comparison' methods may be used.
     """
 
@@ -234,10 +235,10 @@
 
     min_length = Int(
         title=_(u"Minimum length"),
-        description=_(u"""\
+        description=_(u"""
         Value after whitespace processing cannot have less than
-        min_length characters (if a string type) or elements (if
-        another sequence type). If min_length is None, there is
+        `min_length` characters (if a string type) or elements (if
+        another sequence type). If `min_length` is ``None``, there is
         no minimum.
         """),
         required=False,
@@ -246,11 +247,11 @@
 
     max_length = Int(
         title=_(u"Maximum length"),
-        description=_(u"""\
+        description=_(u"""
         Value after whitespace processing cannot have greater
-        or equal than max_length characters (if a string type) or 
-        elements (if another sequence type). If max_length is
-        None, there is no maximum."""),
+        or equal than `max_length` characters (if a string type) or
+        elements (if another sequence type). If `max_length` is
+        ``None``, there is no maximum."""),
         required=False,
         min=0, # needs to be a positive number
         default=None)

Modified: Zope3/trunk/src/zope/tales/tales.py
===================================================================
--- Zope3/trunk/src/zope/tales/tales.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/tales/tales.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -17,6 +17,7 @@
 
 $Id$
 """
+__docformat__ = "reStructuredText"
 import re
 
 from zope.interface import implements
@@ -83,7 +84,7 @@
         >>> it = Iterator('foo', {"apple":1, "pear":1, "orange":1}, context)
         >>> it.next()
         True
-        
+
         >>> it = Iterator('foo', {}, context)
         >>> it.next()
         False
@@ -187,7 +188,7 @@
         """
         index = self._nextIndex - 1
         if index < 0:
-            raise TypeError("No iteration position") 
+            raise TypeError("No iteration position")
         return index
 
     def number(self):

Modified: Zope3/trunk/src/zope/testbrowser/mechanize/_mechanize.py
===================================================================
--- Zope3/trunk/src/zope/testbrowser/mechanize/_mechanize.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zope/testbrowser/mechanize/_mechanize.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -52,7 +52,8 @@
     def __init__(self, base_url, url, text, tag, attrs):
         assert None not in [url, tag, attrs]
         url = url.strip()
-        base_url = base_url.strip()
+        if base_url is not None:
+            base_url = base_url.strip()
         self.base_url = base_url
         self.absolute_url = urlparse.urljoin(base_url, url)
         self.url, self.text, self.tag, self.attrs = url, text, tag, attrs

Modified: Zope3/trunk/src/zwiki/I18N.txt
===================================================================
--- Zope3/trunk/src/zwiki/I18N.txt	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zwiki/I18N.txt	2005-10-30 20:16:09 UTC (rev 39752)
@@ -1,18 +1,19 @@
+===================================================
 Internationalization (I18n) and Localization (L10n)
-=====================================================
+===================================================
 
 Creating/Updating Message Catalog Template (POT) Files
 ------------------------------------------------------
 
-1. Install 'zwiki' in 'ZOPE3/src'. See INSTALL.txt for details.
+1. Install `zwiki` in `ZOPE3/src`. See `INSTALL.txt` for details.
 
 2. Set the the Python path::
 
     export PYTHONPATH=ZOPE3/src
 
-3. Go into the 'locales' directory and execute i18nextract.py::
+3. Go into the `locales` directory and execute `i18nextract.py`::
 
-  python2.4 utilities/i18nextract.py -d zwiki -p ..
+    python2.4 utilities/i18nextract.py -d zwiki -p ..
 
 
 Updating Message Catalog (PO) Files
@@ -29,7 +30,7 @@
 Compiling Message Catalogs (PO) to binary (MO) Files
 ----------------------------------------------------
 
-1. Go to the right directory, such as '<zwiki>/locales/de/LC_MESSAGES'.
+1. Go to the right directory, such as `<zwiki>/locales/de/LC_MESSAGES`.
 
 2. Run the following command::
 

Modified: Zope3/trunk/src/zwiki/interfaces.py
===================================================================
--- Zope3/trunk/src/zwiki/interfaces.py	2005-10-30 18:12:17 UTC (rev 39751)
+++ Zope3/trunk/src/zwiki/interfaces.py	2005-10-30 20:16:09 UTC (rev 39752)
@@ -27,7 +27,7 @@
 from zope.app.container.constraints import ItemTypePrecondition
 from zope.app.event.interfaces import IObjectEvent
 
-from zwiki import ZWikiMessageFactory as _ 
+from zwiki import ZWikiMessageFactory as _
 
 class IComment(Interface):
     """A simple Wiki Page comment.
@@ -80,15 +80,15 @@
         default=u"zope.source.rest",
         required = True,
         vocabulary = "SourceTypes")
-        
 
+
 class IWikiPageContained(IContained):
     """Objects that can be contained by Wiki Pages should implement this
     interface."""
     __parent__ = Field(
         constraint = ContainerTypesConstraint(IWikiPage))
 
-    
+
 class IWikiPageHierarchy(Interface):
     """This interface supports the virtual hierarchical structure of the Wiki
     Pages."""
@@ -122,7 +122,7 @@
         argument set to False, only the first level of children will be
         returned.
         """
-    
+
 class IWiki(IContainer):
     """A simple container that manages Wikis inside itself."""
 
@@ -139,7 +139,7 @@
 
 
 class IWikiPageEditEvent(IObjectEvent):
-    """ an object event containing the old source in addition
+    """An object event containing the old source in addition
     to the changed object
     """
 
@@ -161,5 +161,3 @@
 
     def removeSubscriptions(emails):
         """Remove a set of subscriptions."""
-        
-



More information about the Zope3-Checkins mailing list