[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/ Update doc strings
to ReST
Phil Ruggera
pruggera at san.rr.com
Wed Jul 28 15:09:52 EDT 2004
Log message for revision 26816:
Update doc strings to ReST
Changed:
U Zope3/trunk/src/zope/app/ftp/__init__.py
U Zope3/trunk/src/zope/app/generations/browser/managers.py
U Zope3/trunk/src/zope/app/generations/demo/__init__.py
U Zope3/trunk/src/zope/app/generations/demo/evolve1.py
U Zope3/trunk/src/zope/app/generations/demo/evolve2.py
U Zope3/trunk/src/zope/app/generations/demo/evolve3.py
U Zope3/trunk/src/zope/app/generations/generations.py
U Zope3/trunk/src/zope/app/generations/interfaces.py
U Zope3/trunk/src/zope/app/http/delete.py
U Zope3/trunk/src/zope/app/http/exception/notfound.py
U Zope3/trunk/src/zope/app/http/exception/unauthorized.py
U Zope3/trunk/src/zope/app/http/interfaces.py
U Zope3/trunk/src/zope/app/http/options.py
U Zope3/trunk/src/zope/app/http/put.py
U Zope3/trunk/src/zope/app/http/traversal.py
-=-
Modified: Zope3/trunk/src/zope/app/ftp/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/ftp/__init__.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/ftp/__init__.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -16,6 +16,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import implements
from zope.component import queryAdapter
from zope.proxy import removeAllProxies
Modified: Zope3/trunk/src/zope/app/generations/browser/managers.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/browser/managers.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/browser/managers.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app import zapi
from zope.app.generations.interfaces import ISchemaManager
from zope.app.generations.generations import generations_key, Context
@@ -93,8 +95,8 @@
>>> view = Managers(None, request)
- Now, if we call it's evolve method, it should see that the
- app1 evolve button was pressed and evolve app1 the thect
+ Now, if we call it's `evolve` method, it should see that the
+ app1 evolve button was pressed and evolve app1 to the next
generation.
>>> status = view.evolve()
Modified: Zope3/trunk/src/zope/app/generations/demo/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/demo/__init__.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/demo/__init__.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -18,6 +18,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
key = 'zope.app.generations.demo-generation'
Modified: Zope3/trunk/src/zope/app/generations/demo/evolve1.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/demo/evolve1.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/demo/evolve1.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
generation = 1
Modified: Zope3/trunk/src/zope/app/generations/demo/evolve2.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/demo/evolve2.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/demo/evolve2.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
generation = 2
Modified: Zope3/trunk/src/zope/app/generations/demo/evolve3.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/demo/evolve3.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/demo/evolve3.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
generation = 3
Modified: Zope3/trunk/src/zope/app/generations/generations.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/generations.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/generations.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from interfaces import GenerationTooHigh, GenerationTooLow, UnableToEvolve
from interfaces import ISchemaManager
@@ -27,10 +28,10 @@
class SchemaManager(object):
"""Schema manager
- Schema managers implement ISchemaManager using scripts provided
+ Schema managers implement `ISchemaManager` using scripts provided
as module methods. You create a schema manager by providing
mimumum and maximum generations and a package providing modules
- named `moduleN`, where `N` is a generation number. Each module
+ named ``moduleN``, where ``N`` is a generation number. Each module
provides a function, `evolve` that evolves a database from the
previous generation.
@@ -340,7 +341,7 @@
# An unguarded handler is intended here
get_transaction().abort()
logging.getLogger('zope.app.generations').exception(
- "Failed to evolve database to gneration %d for %s",
+ "Failed to evolve database to generation %d for %s",
generation, key)
if generation < manager.minimum_generation:
Modified: Zope3/trunk/src/zope/app/generations/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/generations/interfaces.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/generations/interfaces.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
import zope.interface
@@ -48,13 +49,13 @@
"""Evolve a database to the given schema generation.
The database should be assumed to be at the schema
- generation one less than the given generation
- argument. In other words, the evolve method is only
+ generation one less than the given `generation`
+ argument. In other words, the `evolve` method is only
required to make one evolutionary step.
- The context argument has a connection attribute,
+ The `context` argument has a connection attribute,
providing a database connection to be used to change
- the database. A context argument is passed rather than
+ the database. A `context` argument is passed rather than
a connection to make it possible to provide additional
information later, if it becomes necessary.
"""
Modified: Zope3/trunk/src/zope/app/http/delete.py
===================================================================
--- Zope3/trunk/src/zope/app/http/delete.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/delete.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -13,6 +13,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.filerepresentation.interfaces import IWriteDirectory
class DELETE(object):
Modified: Zope3/trunk/src/zope/app/http/exception/notfound.py
===================================================================
--- Zope3/trunk/src/zope/app/http/exception/notfound.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/exception/notfound.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.http.interfaces import IHTTPException
from zope.interface import implements
Modified: Zope3/trunk/src/zope/app/http/exception/unauthorized.py
===================================================================
--- Zope3/trunk/src/zope/app/http/exception/unauthorized.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/exception/unauthorized.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.http.interfaces import IHTTPException
from zope.interface import implements
Modified: Zope3/trunk/src/zope/app/http/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/http/interfaces.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/interfaces.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.interface import Interface, Attribute
Modified: Zope3/trunk/src/zope/app/http/options.py
===================================================================
--- Zope3/trunk/src/zope/app/http/options.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/options.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -9,10 +9,12 @@
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
##############################################################################
-"""HTTP method OPTIONS
+"""HTTP method `OPTIONS`
$Id$
"""
+__docformat__ = 'restructuredtext'
+
_allowed_methods = ['PUT', 'DELETE', 'CONNECT', \
'OPTIONS', 'PATCH', 'PROPFIND', 'PROPPATCH', 'MKCOL', \
'COPY', 'MOVE', 'LOCK', 'UNLOCK', 'TRACE']
@@ -21,7 +23,7 @@
from zope.component import queryView
class OPTIONS(object):
- """OPTIONS handler for all objects
+ """`OPTIONS` handler for all objects
"""
def __init__(self, context, request):
Modified: Zope3/trunk/src/zope/app/http/put.py
===================================================================
--- Zope3/trunk/src/zope/app/http/put.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/put.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -9,10 +9,12 @@
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
##############################################################################
-"""HTTP PUT verb
+"""HTTP `PUT` verb
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.component import queryAdapter
from zope.app.http.interfaces import INullResource
from zope.app.filerepresentation.interfaces import IWriteFile
@@ -22,7 +24,7 @@
from zope.interface import implements
class NullResource(object):
- """Object representing objects to be created by a PUT.
+ """Object representing objects to be created by a `PUT`.
"""
implements(INullResource)
Modified: Zope3/trunk/src/zope/app/http/traversal.py
===================================================================
--- Zope3/trunk/src/zope/app/http/traversal.py 2004-07-28 19:00:37 UTC (rev 26815)
+++ Zope3/trunk/src/zope/app/http/traversal.py 2004-07-28 19:09:51 UTC (rev 26816)
@@ -16,6 +16,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.publisher.interfaces.http import IHTTPPublisher
from zope.app.container.interfaces import ISimpleReadContainer, IItemContainer
from zope.app.http.put import NullResource
More information about the Zope3-Checkins
mailing list