[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/ Update doc strings
to ReST
Phil Ruggera
pruggera at san.rr.com
Mon Aug 9 00:06:37 EDT 2004
Log message for revision 26955:
Update doc strings to ReST
Changed:
U Zope3/trunk/src/zope/app/menu/__init__.py
U Zope3/trunk/src/zope/app/menu/browser/__init__.py
U Zope3/trunk/src/zope/app/menu/interfaces.py
U Zope3/trunk/src/zope/app/observable/interfaces.py
U Zope3/trunk/src/zope/app/observable/observable.py
U Zope3/trunk/src/zope/app/observable/observerevent.py
U Zope3/trunk/src/zope/app/observable/observers.py
U Zope3/trunk/src/zope/app/onlinehelp/__init__.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/metaconfigure.py
U Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py
U Zope3/trunk/src/zope/app/onlinehelp/onlinehelp.py
U Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py
U Zope3/trunk/src/zope/app/pagetemplate/__init__.py
U Zope3/trunk/src/zope/app/pagetemplate/engine.py
U Zope3/trunk/src/zope/app/pagetemplate/interfaces.py
U Zope3/trunk/src/zope/app/pagetemplate/metaconfigure.py
U Zope3/trunk/src/zope/app/pagetemplate/simpleviewclass.py
U Zope3/trunk/src/zope/app/pagetemplate/talesapi.py
U Zope3/trunk/src/zope/app/pagetemplate/urlquote.py
U Zope3/trunk/src/zope/app/pagetemplate/viewpagetemplatefile.py
U Zope3/trunk/src/zope/app/pluggableauth/__init__.py
U Zope3/trunk/src/zope/app/pluggableauth/interfaces.py
U Zope3/trunk/src/zope/app/presentation/__init__.py
U Zope3/trunk/src/zope/app/presentation/browser/__init__.py
U Zope3/trunk/src/zope/app/presentation/browser/pagefolder.py
U Zope3/trunk/src/zope/app/presentation/browser/zpt.py
U Zope3/trunk/src/zope/app/presentation/pagefolder.py
U Zope3/trunk/src/zope/app/presentation/presentation.py
U Zope3/trunk/src/zope/app/presentation/zpt.py
U Zope3/trunk/src/zope/app/principalannotation/__init__.py
U Zope3/trunk/src/zope/app/principalannotation/interfaces.py
U Zope3/trunk/src/zope/app/publication/browser.py
U Zope3/trunk/src/zope/app/publication/ftp.py
U Zope3/trunk/src/zope/app/publication/http.py
U Zope3/trunk/src/zope/app/publication/httpfactory.py
U Zope3/trunk/src/zope/app/publication/interfaces.py
U Zope3/trunk/src/zope/app/publication/publicationtraverse.py
U Zope3/trunk/src/zope/app/publication/traversers.py
U Zope3/trunk/src/zope/app/publication/xmlrpc.py
U Zope3/trunk/src/zope/app/publication/zopepublication.py
-=-
Modified: Zope3/trunk/src/zope/app/menu/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/menu/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/menu/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from persistent import Persistent
from zope.interface import implements, providedBy
from zope.component.exceptions import ComponentLookupError
@@ -100,7 +102,7 @@
class LocalBrowserMenuService(BaseBrowserMenuService, Persistent, Contained):
"""This implementation strongly depends on the semantics of
- GlobalBrowserMenuService."""
+ `GlobalBrowserMenuService`."""
implements(ILocalBrowserMenuService, ISimpleService)
@@ -109,14 +111,14 @@
def getAllLocalMenus(self):
- """See zope.app.publisher.interfaces.browser.IBrowserMenuService"""
+ """See `zope.app.publisher.interfaces.browser.IBrowserMenuService`"""
utilities = zapi.getService(Utilities, self)
menus = utilities.getLocalUtilitiesFor(ILocalBrowserMenu)
return map(lambda m: m[1], menus)
def getLocalMenu(self, menu_id):
- """See zope.app.interfaces.services.menu.ILocalBrowserMenuService"""
+ """See `zope.app.interfaces.services.menu.ILocalBrowserMenuService`"""
menu = self.queryLocalMenu(menu_id)
if menu is None:
raise ComponentLookupError(menu_id)
@@ -124,7 +126,7 @@
def queryLocalMenu(self, menu_id, default=None):
- """See zope.app.interfaces.services.menu.ILocalBrowserMenuService"""
+ """See `zope.app.interfaces.services.menu.ILocalBrowserMenuService`"""
utilities = zapi.getService(Utilities, self)
menus = utilities.getLocalUtilitiesFor(ILocalBrowserMenu)
for name, menu in menus:
@@ -134,7 +136,7 @@
def getInheritedMenu(self, menu_id, canBeLocal=False):
- """See zope.app.interfaces.services.menu.ILocalBrowserMenuService"""
+ """See `zope.app.interfaces.services.menu.ILocalBrowserMenuService`"""
menu = self.queryInheritedMenu(menu_id, canBeLocal)
if menu is None:
raise ComponentLookupError(menu_id)
@@ -142,7 +144,7 @@
def queryInheritedMenu(self, menu_id, canBeLocal=False, default=None):
- """See zope.app.interfaces.services.menu.ILocalBrowserMenuService"""
+ """See `zope.app.interfaces.services.menu.ILocalBrowserMenuService`"""
if canBeLocal and self.queryLocalMenu(menu_id) is not None:
return self.queryLocalMenu(menu_id)
# Another service (global) should always be available
@@ -156,7 +158,7 @@
def getAllMenuItems(self, menu_id, object):
- """See zope.app.publisher.interfaces.browser.IBrowserMenuService"""
+ """See `zope.app.publisher.interfaces.browser.IBrowserMenuService`"""
result = []
# Find the local items, if available
@@ -176,13 +178,13 @@
def getMenu(self, menu_id, object, request, max=999999):
- """See zope.app.publisher.interfaces.browser.IBrowserMenuService"""
+ """See `zope.app.publisher.interfaces.browser.IBrowserMenuService`"""
return super(LocalBrowserMenuService,
self).getMenu(menu_id, object, request, max)
def getFirstMenuItem(self, menu_id, object, request):
- """See zope.app.publisher.interfaces.browser.IBrowserMenuService"""
+ """See `zope.app.publisher.interfaces.browser.IBrowserMenuService`"""
return super(LocalBrowserMenuService,
self).getFirstMenuItem(menu_id, object, request)
Modified: Zope3/trunk/src/zope/app/menu/browser/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/menu/browser/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/menu/browser/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements
from zope.app import zapi
from zope.app.container.browser.contents import Contents
Modified: Zope3/trunk/src/zope/app/menu/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/menu/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/menu/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.schema import Bool
from zope.app.i18n import ZopeMessageIDFactory as _
from zope.app.publisher.interfaces.browser import \
@@ -47,26 +49,26 @@
"""Get a local menu by id.
If there is no such menu found locally, this method needs to raise a
- ComponentLookupError.
+ ``ComponentLookupError``.
"""
def queryLocalMenu(menu_id, default=None):
"""Get a local menu by id.
- If no menu was found, the default value is returned.
+ If no menu was found, the `default` value is returned.
"""
def getInheritedMenu(menu_id, canBeLocal=False):
"""Tries to get the first available menu.
- If canBeLocal is True, then it also looks locally for a matching
- menu. This method should return a ComponentLookupError, if the menu
+ If `canBeLocal` is ``True``, then it also looks locally for a matching
+ menu. This method should return a ``ComponentLookupError``, if the menu
was not found.
"""
def queryInheritedMenu(menu_id, canBeLocal=False, default=None):
"""Tries to get the first available menu.
- If canBeLocal is True, then it also looks locally for a matching
- menu. If no menu was ound, default is returned.
+ If `canBeLocal` is ``True``, then it also looks locally for a matching
+ menu. If no menu was found, `default` is returned.
"""
Modified: Zope3/trunk/src/zope/app/observable/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/observable/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/observable/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.interface.interfaces import Interface
@@ -24,7 +25,7 @@
"""Call registered event handlers"""
def handle(interfaces, handler):
- """Register a handler for some interfaces
+ """Register a `handler` for some `interfaces`
The handler will be called with object's implementing the
interface. Typically, one of the objects will be an
@@ -38,5 +39,5 @@
"""
def unhandle(interfaces, handler):
- """Unregister a handler for some interfaces
+ """Unregister a `handler` for some `interfaces`
"""
Modified: Zope3/trunk/src/zope/app/observable/observable.py
===================================================================
--- Zope3/trunk/src/zope/app/observable/observable.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/observable/observable.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements, providedBy
from zope.app.observable.interfaces import IObservable
from zope.app.annotation.interfaces import IAnnotations
Modified: Zope3/trunk/src/zope/app/observable/observerevent.py
===================================================================
--- Zope3/trunk/src/zope/app/observable/observerevent.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/observable/observerevent.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.app.observable.interfaces import IObservable
Modified: Zope3/trunk/src/zope/app/observable/observers.py
===================================================================
--- Zope3/trunk/src/zope/app/observable/observers.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/observable/observers.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,8 +13,8 @@
##############################################################################
"""Observer Registry
-Observers observe other objects by getting notified of object events
-on those objects. Observers subscribe to particular types of events.
+`Observers` observe other objects by getting notified of object events
+on those objects. `Observers` subscribe to particular types of events.
>>> registry = Observers()
@@ -40,7 +40,7 @@
>>> subs
['sub12 1', 'sub12 2']
-You can register subscribers for all specifications using None::
+You can register subscribers for all specifications using ``None``::
>>> class IR2(IR1):
... pass
@@ -106,8 +106,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
-
from persistent import Persistent
from zope.interface.adapter import Default, Null
from zope.interface.adapter import Surrogate, AdapterRegistry
Modified: Zope3/trunk/src/zope/app/onlinehelp/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,10 +13,12 @@
##############################################################################
"""OnlineHelp System.
-Create the global OnlineHelp instance.
+Create the global `OnlineHelp` instance.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import os
import zope
@@ -42,7 +44,7 @@
def traverse(self, name, ignored):
"""Used to traverse to an online help topic.
- Returns the global OnlineHelp instance with the traversal
+ Returns the global `OnlineHelp` instance with the traversal
context.
"""
help.context = self.context
Modified: Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/browser/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -11,10 +11,12 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""OnlineHelp views
+"""`OnlineHelp` views
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.proxy import removeAllProxies
from zope.app import zapi
Modified: Zope3/trunk/src/zope/app/onlinehelp/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,10 +13,12 @@
##############################################################################
"""OnlineHelp Interfaces
-These are the interfaces designed for the OnlineHelp system.
+These are the interfaces designed for the `OnlineHelp` system.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.schema import TextLine, SourceText, Choice
from zope.configuration.fields import GlobalObject
from zope.app.container.interfaces import IContainer
@@ -38,7 +40,7 @@
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 by the IContainer
+ Note that all the Sub-Topic management is done by the `IContainer`
interface.
"""
@@ -111,26 +113,26 @@
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
+ `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
+ `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
+ `doc_path` -- Specifies where the file that contains the topic
content is located.
- interface -- Name of the interface for which the help topic is
+ `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
+ `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,
+ `resources` -- Specifies a list of resources for the topic,
for example images that are included by the rendered topic content.
Optional.
"""
Modified: Zope3/trunk/src/zope/app/onlinehelp/metaconfigure.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/metaconfigure.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/metaconfigure.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,16 +13,18 @@
##############################################################################
"""Meta-Configuration Handlers for "help" namespace.
-These handlers process the registerTopic() directive of
+These handlers process the `registerTopic()` directive of
the "help" ZCML namespace.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.onlinehelp import help
def register(_context, id, title, parent="", doc_path=None, for_=None,
view=None, resources=None):
- """Register an OnlineHelp topic"""
+ """Register an `OnlineHelp` topic"""
_context.action(
discriminator = ('registerHelpTopic', parent, id),
Modified: Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/metadirectives.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -16,6 +16,7 @@
$Id$
"""
__docformat__ = 'restructuredtext'
+
from zope.configuration.fields import GlobalObject, Path, MessageID, Tokens
from zope.interface import Interface
from zope.schema import BytesLine, TextLine
Modified: Zope3/trunk/src/zope/app/onlinehelp/onlinehelp.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/onlinehelp.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/onlinehelp.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,11 +13,13 @@
##############################################################################
"""Implementation of OnlineHelp System.
-This the default implementation of the OnlineHelp. It defines the global
-OnlineHelp in which all basic Zope-core help screens are registered.
+This the default implementation of the `OnlineHelp`. It defines the global
+`OnlineHelp` in which all basic Zope-core help screens are registered.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements
from zope.component.servicenames import Utilities
from zope.app import zapi
@@ -33,7 +35,7 @@
>>> from zope.app.onlinehelp.tests.test_onlinehelp import I1, Dummy1
>>> path = os.path.join(testdir(), 'help.txt')
- Create an onlinehelp instance
+ Create an `OnlineHelp` instance
>>> onlinehelp = OnlineHelp('Help', path)
Modified: Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py
===================================================================
--- Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/onlinehelp/onlinehelptopic.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -16,6 +16,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import os
from persistent import Persistent
Modified: Zope3/trunk/src/zope/app/pagetemplate/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,5 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.pagetemplate.viewpagetemplatefile import ViewPageTemplateFile
#from zope.app.pagetemplate.simpleviewclass import SimpleViewClass
Modified: Zope3/trunk/src/zope/app/pagetemplate/engine.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/engine.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/engine.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -17,6 +17,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import sys
from zope.interface import implements
@@ -224,8 +226,8 @@
...
KeyError: 'zope.app.pagetemplate.tests.trusted'
- (The use of KeyError is an unfortunate implementation detail; I
- think this should be a NotFoundError.)
+ (The use of ``KeyError`` is an unfortunate implementation detail; I
+ think this should be a ``NotFoundError``.)
Modules which have already been imported by trusted code are
available, wrapped in security proxies::
Modified: Zope3/trunk/src/zope/app/pagetemplate/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.dublincore.interfaces import IDCDescriptiveProperties
from zope.app.dublincore.interfaces import IDCTimes
from zope.interface import Interface
Modified: Zope3/trunk/src/zope/app/pagetemplate/metaconfigure.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/metaconfigure.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/metaconfigure.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -16,6 +16,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.pagetemplate.engine import Engine, _Engine
from zope.app.pagetemplate.engine import TrustedEngine, _TrustedEngine
from zope.testing.cleanup import addCleanUp
Modified: Zope3/trunk/src/zope/app/pagetemplate/simpleviewclass.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/simpleviewclass.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/simpleviewclass.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import sys
from zope.app.publisher.browser import BrowserView
from zope.publisher.interfaces.browser import IBrowserPublisher
Modified: Zope3/trunk/src/zope/app/pagetemplate/talesapi.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/talesapi.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/talesapi.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.dublincore.interfaces import IZopeDublinCore
from zope.app.size.interfaces import ISized
from zope.app import zapi
Modified: Zope3/trunk/src/zope/app/pagetemplate/urlquote.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/urlquote.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/urlquote.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id: simpleviewclass.py 25177 2004-06-02 13:17:31Z jim $
"""
+__docformat__ = 'restructuredtext'
import urllib
from zope.interface import implements
Modified: Zope3/trunk/src/zope/app/pagetemplate/viewpagetemplatefile.py
===================================================================
--- Zope3/trunk/src/zope/app/pagetemplate/viewpagetemplatefile.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pagetemplate/viewpagetemplatefile.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.pagetemplate.pagetemplatefile import PageTemplateFile
from zope.component import getView
from zope.app.pagetemplate.engine import TrustedAppPT
Modified: Zope3/trunk/src/zope/app/pluggableauth/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/pluggableauth/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pluggableauth/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import random
import sys
import time
@@ -52,7 +54,7 @@
IPrincipalSource, ILoginPasswordPrincipalSource, IContainerPrincipalSource
def gen_key():
- """Return a random int (1, MAXINT), suitable for use as a BTree key."""
+ """Return a random int (1, MAXINT), suitable for use as a `BTree` key."""
return random.randint(0, sys.maxint-1)
@@ -75,7 +77,7 @@
OrderedContainer.__init__(self)
def authenticate(self, request):
- """ See IAuthenticationService. """
+ """ See `IAuthenticationService`. """
for ps_key, ps in self.items():
loginView = zapi.queryView(ps, "login", request)
if loginView is not None:
@@ -95,7 +97,7 @@
return None
def unauthorized(self, id, request):
- """ See IAuthenticationService. """
+ """ See `IAuthenticationService`. """
next = queryNextService(self, Authentication, None)
if next is not None:
@@ -104,12 +106,12 @@
return None
def getPrincipal(self, id):
- """ See IAuthenticationService.
+ """ See `IAuthenticationService`.
- For this implementation, an 'id' is a string which can be
+ For this implementation, an `id` is a string which can be
split into a 3-tuple by splitting on tab characters. The
- three tuple consists of (auth_service_earmark,
- principal_source_id, principal_id).
+ three tuple consists of (`auth_service_earmark`,
+ `principal_source_id`, `principal_id`).
In the current strategy, the principal sources that are members
of this authentication service cannot be renamed; if they are,
@@ -139,7 +141,7 @@
return source.getPrincipal(id)
def getPrincipals(self, name):
- """ See IAuthenticationService. """
+ """ See `IAuthenticationService`. """
for ps_key, ps in self.items():
for p in ps.getPrincipals(name):
@@ -151,7 +153,7 @@
yield p
def addPrincipalSource(self, id, principal_source):
- """ See IPluggableAuthenticationService.
+ """ See `IPluggableAuthenticationService`.
>>> pas = PluggableAuthenticationService()
>>> sps = BTreePrincipalSource()
@@ -168,7 +170,7 @@
self[id] = principal_source
def removePrincipalSource(self, id):
- """ See IPluggableAuthenticationService.
+ """ See `IPluggableAuthenticationService`.
>>> pas = PluggableAuthenticationService()
>>> sps = BTreePrincipalSource()
@@ -190,7 +192,7 @@
def PluggableAuthenticationServiceAddSubscriber(self, event):
r"""Generates an earmark if one is not provided.
- Define a stub for PluggableAuthenticationService
+ Define a stub for `PluggableAuthenticationService`
>>> from zope.app.traversing.interfaces import IPhysicallyLocatable
>>> class PluggableAuthStub(object):
@@ -236,7 +238,7 @@
):
def __setitem__(name, principal):
- """Add a principal
+ """Add a `principal`
The name must be the same as the principal login
"""
@@ -262,7 +264,7 @@
# IContainer-related methods
def __delitem__(self, login):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> prin = SimplePrincipal('fred', 'fred', '123')
@@ -281,7 +283,7 @@
del self._numbers_by_login[login]
def __setitem__(self, login, ob):
- """ See IContainerNamesContainer
+ """ See `IContainerNamesContainer`
>>> sps = BTreePrincipalSource()
>>> prin = SimplePrincipal('gandalf', 'shadowfax')
@@ -301,7 +303,7 @@
self._numbers_by_login[ob.login] = key
def keys(self):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> sps.keys()
@@ -319,7 +321,7 @@
return list(self._numbers_by_login.keys())
def __iter__(self):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> sps.keys()
@@ -335,7 +337,7 @@
return iter(self.keys())
def __getitem__(self, key):
- """ See IContainer
+ """ See `IContainer`
>>> sps = BTreePrincipalSource()
>>> prin = SimplePrincipal('gag', 'justzisguy')
@@ -348,7 +350,7 @@
return self._principals_by_number[number]
def get(self, key, default=None):
- """ See IContainer
+ """ See `IContainer`
>>> sps = BTreePrincipalSource()
>>> prin = SimplePrincipal(1, 'slartibartfast', 'fjord')
@@ -366,7 +368,7 @@
return self._principals_by_number[number]
def values(self):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> sps.keys()
@@ -385,7 +387,7 @@
for n in self._numbers_by_login.values()]
def __len__(self):
- """ See IContainer
+ """ See `IContainer`
>>> sps = BTreePrincipalSource()
>>> int(len(sps) == 0)
@@ -399,7 +401,7 @@
return len(self._principals_by_number)
def items(self):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> sps.keys()
@@ -418,7 +420,7 @@
return [(p.login, p) for p in self.values()]
def __contains__(self, key):
- """ See IContainer.
+ """ See `IContainer`.
>>> sps = BTreePrincipalSource()
>>> prin = SimplePrincipal('slinkp', 'password')
@@ -435,9 +437,9 @@
# PrincipalSource-related methods
def getPrincipal(self, id):
- """ See IPrincipalSource.
+ """ See `IPrincipalSource`.
- 'id' is the id as returned by principal.getId(),
+ `id` is the id as returned by ``principal.getId()``,
not a login.
"""
@@ -451,7 +453,7 @@
raise NotFoundError, id
def getPrincipals(self, name):
- """ See IPrincipalSource.
+ """ See `IPrincipalSource`.
>>> sps = BTreePrincipalSource()
>>> prin1 = SimplePrincipal('gandalf', 'shadowfax')
@@ -477,7 +479,7 @@
yield self[k]
def authenticate(self, login, password):
- """ See ILoginPasswordPrincipalSource. """
+ """ See `ILoginPasswordPrincipalSource`. """
number = self._numbers_by_login.get(login)
if number is None:
return
@@ -522,7 +524,7 @@
class SimplePrincipal(Persistent, Contained):
- """A no-frills IUserSchemafied implementation."""
+ """A no-frills `IUserSchemafied` implementation."""
implements(IUserSchemafied, IBTreePrincipalSourceContained)
@@ -554,11 +556,11 @@
return self.description
def getLogin(self):
- """See IReadUser."""
+ """See `IReadUser`."""
return self.login
def validate(self, test_password):
- """ See IReadUser.
+ """ See `IReadUser`.
>>> pal = SimplePrincipal('gandalf', 'shadowfax', 'The Grey Wizard',
... 'Cool old man with neato fireworks. '
@@ -574,7 +576,7 @@
"""Simple basic authentication view
This only handles requests which have basic auth credentials
- in them currently (ILoginPassword-based requests).
+ in them currently (`ILoginPassword`-based requests).
If you want a different policy, you'll need to write and register
a different view, replacing this one.
Modified: Zope3/trunk/src/zope/app/pluggableauth/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/pluggableauth/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/pluggableauth/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.i18n import ZopeMessageIDFactory as _
from zope.app.container.interfaces import IContainer, IContained
from zope.app.container.constraints import ItemTypePrecondition
@@ -42,14 +44,14 @@
class IPrincipalSource(Interface):
- """A read-only source of IPrincipals.
+ """A read-only source of `IPrincipals`.
"""
def getPrincipal(id):
"""Get principal meta-data.
- Returns an object of type IPrincipal for the given principal
- id. A NotFoundError is raised if the principal cannot be
+ Returns an object of type `IPrincipal` for the given principal
+ id. A ``NotFoundError`` is raised if the principal cannot be
found.
Note that the id has three parts, separated by tabs. The
@@ -73,7 +75,7 @@
class IPluggableAuthenticationService(IAuthenticationService, IContainer):
- """An AuthenticationService that can contain multiple pricipal sources.
+ """An `AuthenticationService` that can contain multiple pricipal sources.
"""
def __setitem__(id, principal_source):
@@ -81,9 +83,9 @@
__setitem__.precondition = ItemTypePrecondition(IPrincipalSource)
def removePrincipalSource(id):
- """Remove a PrincipalSource.
+ """Remove a `PrincipalSource`.
- If id is not present, raise KeyError.
+ If id is not present, raise ``KeyError``.
"""
@@ -95,7 +97,7 @@
""" 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.
+ matches the login/password pair, return ``None``.
Note: A login is different than an id. Principals may have
logins that differ from their id. For example, a user may
Modified: Zope3/trunk/src/zope/app/presentation/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.app.presentation.presentation import IPageRegistration
from zope.app.presentation.presentation import PageRegistration
Modified: Zope3/trunk/src/zope/app/presentation/browser/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/browser/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/browser/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
class PageRegistrationView(object):
"""Helper class for the page edit form."""
Modified: Zope3/trunk/src/zope/app/presentation/browser/pagefolder.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/browser/pagefolder.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/browser/pagefolder.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.presentation.pagefolder import IPageFolder
class PageFolderDefaultConfiguration(object):
Modified: Zope3/trunk/src/zope/app/presentation/browser/zpt.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/browser/zpt.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/browser/zpt.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
class Source(object):
def __call__(self):
Modified: Zope3/trunk/src/zope/app/presentation/pagefolder.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/pagefolder.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/pagefolder.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -18,6 +18,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import Interface, implements
from zope.schema import BytesLine, Bool, Field, Choice
@@ -177,7 +179,7 @@
)
class PageFolderAdapter(ObjectEntryAdapter):
- """ObjectFile adapter for PageFolder objects."""
+ """ObjectFile adapter for `PageFolder` objects."""
implements(IObjectDirectory)
Modified: Zope3/trunk/src/zope/app/presentation/presentation.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/presentation.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/presentation.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import persistent.dict
from zope.interface import implements, providedBy, Interface, Attribute
@@ -91,7 +93,7 @@
providing=Interface):
"""Look for a named view for a given object and request
- The request must implement IPresentationRequest.
+ The request must implement `IPresentationRequest`.
The default will be returned if the component can't be found.
"""
@@ -116,7 +118,7 @@
def queryResource(self, name, request, default=None, providing=Interface):
"""Look up a named resource for a given request
- The request must implement IPresentationRequest.
+ The request must implement `IPresentationRequest`.
The default will be returned if the component can't be found.
"""
Modified: Zope3/trunk/src/zope/app/presentation/zpt.py
===================================================================
--- Zope3/trunk/src/zope/app/presentation/zpt.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/presentation/zpt.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import re
from zope.security.proxy import ProxyFactory
@@ -57,11 +59,11 @@
def render(context, request, *args, **kw):
"""Render the page template.
- The context argument is bound to the top-level 'context'
+ The context argument is bound to the top-level `context`
variable. The request argument is bound to the top-level
- 'request' variable. The positional arguments are bound to the
- 'args' variable and the keyword arguments are bound to the
- 'options' variable.
+ `request` variable. The positional arguments are bound to the
+ `args` variable and the keyword arguments are bound to the
+ `options` variable.
"""
@@ -74,11 +76,11 @@
usage = u''
def getSource(self):
- """See zope.app.presentation.zpt.IZPTInfo"""
+ """See `zope.app.presentation.zpt.IZPTInfo`"""
return self.read()
def setSource(self, text):
- """See zope.app.presentation.zpt.IZPTInfo"""
+ """See `zope.app.presentation.zpt.IZPTInfo`"""
if not isinstance(text, unicode):
raise TypeError("source text must be Unicode" , text)
self.pt_edit(text, self.contentType)
@@ -161,7 +163,7 @@
class ZPTPageAdapter(ObjectEntryAdapter):
- """ObjectFile adapter for ZPTTemplate objects."""
+ """ObjectFile adapter for `ZPTTemplate` objects."""
implements(IObjectFile)
Modified: Zope3/trunk/src/zope/app/principalannotation/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/principalannotation/__init__.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/principalannotation/__init__.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -11,10 +11,11 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""Implementation of IPrincipalAnnotationService.
+"""Implementation of `IPrincipalAnnotationService`.
$Id$
"""
+__docformat__ = 'restructuredtext'
# TODO: register service as adapter for IAnnotations on service activation
# this depends on existence of LocalAdapterService, so once that's done
@@ -35,7 +36,7 @@
from zope.app.location import Location
class PrincipalAnnotationService(Persistent, Contained):
- """Stores IAnnotations for IPrinicipals.
+ """Stores `IAnnotations` for `IPrinicipals`.
The service ID is 'PrincipalAnnotation'.
"""
@@ -48,14 +49,14 @@
def getAnnotations(self, principal):
"""Return object implementing IAnnotations for the given principal.
- If there is no IAnnotations it will be created and then returned.
+ If there is no `IAnnotations` it will be created and then returned.
"""
return self.getAnnotationsById(principal.id)
def getAnnotationsById(self, principalId):
- """Return object implementing IAnnotations for the given principal.
+ """Return object implementing `IAnnotations` for the given principal.
- If there is no IAnnotations it will be created and then returned.
+ If there is no `IAnnotations` it will be created and then returned.
"""
annotations = self.annotations.get(principalId)
@@ -67,7 +68,7 @@
return annotations
def hasAnnotations(self, principal):
- """Return boolean indicating if given principal has IAnnotations."""
+ """Return boolean indicating if given principal has `IAnnotations`."""
return principal.id in self.annotations
@@ -112,7 +113,8 @@
class AnnotationsForPrincipal(object):
- """Adapter from IPrincipal to IAnnotations for a PrincipalAnnotationService.
+ """Adapter from IPrincipal to `IAnnotations` for a
+ `PrincipalAnnotationService`.
Register an *instance* of this class as an adapter.
"""
Modified: Zope3/trunk/src/zope/app/principalannotation/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/principalannotation/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/principalannotation/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -11,27 +11,32 @@
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
-"""Service for storing IAnnotations for principals.
+"""Service for storing `IAnnotations` for principals.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import Interface
class IPrincipalAnnotationService(Interface):
- """Stores IAnnotations for IPrinicipals."""
+ """Stores `IAnnotations` for `IPrinicipals`."""
def getAnnotations(principal):
- """Return object implementing IAnnotations for the given IPrinicipal.
+ """Return object implementing `IAnnotations` for the given
+ `IPrinicipal`.
- If there is no IAnnotations it will be created and then returned.
+ If there is no `IAnnotations` it will be created and then returned.
"""
def getAnnotationsById(principalId):
- """Return object implementing IAnnotations for the given prinicipal id.
+ """Return object implementing `IAnnotations` for the given
+ `prinicipalId`.
- If there is no IAnnotations it will be created and then returned.
+ If there is no `IAnnotations` it will be created and then returned.
"""
def hasAnnotations(principal):
- """Return boolean indicating if given IPrincipal has IAnnotations."""
+ """Return boolean indicating if given `IPrincipal` has
+ `IAnnotations`."""
Modified: Zope3/trunk/src/zope/app/publication/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/browser.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/browser.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -18,6 +18,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.publication.publicationtraverse \
import PublicationTraverser as PublicationTraverser_
from zope.app.publication.http import BaseHTTPPublication
Modified: Zope3/trunk/src/zope/app/publication/ftp.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/ftp.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/ftp.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.publication.zopepublication import ZopePublication
from zope.component import queryView
Modified: Zope3/trunk/src/zope/app/publication/http.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/http.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/http.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.publication.zopepublication import ZopePublication
from zope.component import getView
from zope.publisher.publish import mapply
Modified: Zope3/trunk/src/zope/app/publication/httpfactory.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/httpfactory.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/httpfactory.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements
from zope.publisher.http import HTTPRequest
from zope.publisher.browser import BrowserRequest
@@ -32,13 +34,13 @@
implements(IPublicationRequestFactory)
def __init__(self, db):
- """See zope.app.publication.interfaces.IPublicationRequestFactory"""
+ """See `zope.app.publication.interfaces.IPublicationRequestFactory`"""
self._http = HTTPPublication(db)
self._brower = BrowserPublication(db)
self._xmlrpc = XMLRPCPublication(db)
def __call__(self, input_stream, output_steam, env):
- """See zope.app.publication.interfaces.IPublicationRequestFactory"""
+ """See `zope.app.publication.interfaces.IPublicationRequestFactory`"""
method = env.get('REQUEST_METHOD', 'GET').upper()
if method in _browser_methods:
Modified: Zope3/trunk/src/zope/app/publication/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/interfaces.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/interfaces.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.interface import implements, Interface
Modified: Zope3/trunk/src/zope/app/publication/publicationtraverse.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/publicationtraverse.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/publicationtraverse.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.component import queryViewProviding
from zope.publisher.interfaces import NotFound
from types import StringTypes
Modified: Zope3/trunk/src/zope/app/publication/traversers.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/traversers.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/traversers.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import providedBy, implements
from zope.publisher.interfaces import Unauthorized, NotFound
from zope.publisher.interfaces.browser import IBrowserPublisher
Modified: Zope3/trunk/src/zope/app/publication/xmlrpc.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/xmlrpc.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/xmlrpc.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -13,10 +13,12 @@
##############################################################################
"""XML-RPC Publication Handler.
-This module specifically implements a custom nameTraverse() method.
+This module specifically implements a custom `nameTraverse()` method.
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.component import queryView, queryDefaultViewName
from zope.proxy import removeAllProxies
from zope.app.publisher.interfaces.xmlrpc import IXMLRPCPresentation
@@ -31,18 +33,19 @@
The method should try the following things in this order:
- 1. Check whether ob is a view; if so try to find a public method
+ 1. Check whether `ob` is a view; if so try to find a public method
having the passed name.
- 2. If the ob is not a view, then we try to find a view for it. This
+ 2. If `ob` is not a view, then we try to find a view for it. This
can be done in two ways:
(a) Look whether there is a view registered for this name.
- (b) Check whether the default view has a matching method called name.
+ (b) Check whether the default view has a matching method called
+ name.
3. See whether the object has a subobject of this name. This test is
- done last, since this is done by ZopePublication, and it knows how
+ done last, since this is done by `ZopePublication`, and it knows how
to create all the correct error messages. No need for us to do that.
"""
Modified: Zope3/trunk/src/zope/app/publication/zopepublication.py
===================================================================
--- Zope3/trunk/src/zope/app/publication/zopepublication.py 2004-08-07 18:13:47 UTC (rev 26954)
+++ Zope3/trunk/src/zope/app/publication/zopepublication.py 2004-08-09 04:06:35 UTC (rev 26955)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import sys
import logging
from new import instancemethod
@@ -164,7 +166,7 @@
"""Set some useful meta-information on the transaction. This
information is used by the undo framework, for example.
- This method is not part of the IPublication interface, since
+ This method is not part of the `IPublication` interface, since
it's specific to this particular implementation.
"""
txn.setUser(request.principal.id)
More information about the Zope3-Checkins
mailing list