[Zope3-checkins] SVN: Zope3/trunk/src/zope/app/ Update doc strings
to ReST
Phil Ruggera
pruggera at san.rr.com
Wed Aug 4 01:10:21 EDT 2004
Log message for revision 26892:
Update doc strings to ReST
Changed:
U Zope3/trunk/src/zope/app/interpreter/interfaces.py
U Zope3/trunk/src/zope/app/interpreter/python.py
U Zope3/trunk/src/zope/app/introspector/__init__.py
U Zope3/trunk/src/zope/app/introspector/browser.py
U Zope3/trunk/src/zope/app/introspector/interfaces.py
U Zope3/trunk/src/zope/app/locales/extract.py
U Zope3/trunk/src/zope/app/locales/interfaces.py
U Zope3/trunk/src/zope/app/locales/pygettext.py
-=-
Modified: Zope3/trunk/src/zope/app/interpreter/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/interpreter/interfaces.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/interpreter/interfaces.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import Interface
class IInterpreter(Interface):
Modified: Zope3/trunk/src/zope/app/interpreter/python.py
===================================================================
--- Zope3/trunk/src/zope/app/interpreter/python.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/interpreter/python.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from StringIO import StringIO
import sys
@@ -27,7 +29,7 @@
implements(IInterpreter)
def evaluate(self, code, globals):
- """See zope.app.interfaces.IInterpreter"""
+ """See `zope.app.interfaces.IInterpreter`"""
tmp = StringIO()
globals['untrusted_output'] = tmp
if isinstance(code, basestring):
@@ -44,7 +46,7 @@
def evaluateRawCode(self, code, globals):
- """See zope.app.interfaces.IInterpreter"""
+ """See `zope.app.interfaces.IInterpreter`"""
# Removing probable comments
if code.strip().startswith('<!--') and code.strip().endswith('-->'):
code = code.strip()[4:-3]
Modified: Zope3/trunk/src/zope/app/introspector/__init__.py
===================================================================
--- Zope3/trunk/src/zope/app/introspector/__init__.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/introspector/__init__.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import Interface
from zope.app.introspector.interfaces import IIntrospector
from zope.app.module.interfaces import IModuleService
@@ -142,21 +144,21 @@
return service
def getDirectlyProvided(self):
- """See IIntrospector"""
+ """See `IIntrospector`"""
return directlyProvidedBy(removeAllProxies(self.context))
def getDirectlyProvidedNames(self):
- """See IIntrospector"""
+ """See `IIntrospector`"""
return self.getInterfaceNames(self.getDirectlyProvided())
def getMarkerInterfaceNames(self):
- """See IIntrospector"""
+ """See `IIntrospector`"""
result = list(self.getInterfaceNames(self.getMarkerInterfaces()))
result.sort()
return tuple(result)
def getMarkerInterfaces(self):
- """See IIntrospector"""
+ """See `IIntrospector`"""
results = []
todo = list(providedBy(removeAllProxies(self.context)))
Modified: Zope3/trunk/src/zope/app/introspector/browser.py
===================================================================
--- Zope3/trunk/src/zope/app/introspector/browser.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/introspector/browser.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.app.publisher.browser import BrowserView
from zope.app.introspector.interfaces import IIntrospector
from zope.app import zapi
Modified: Zope3/trunk/src/zope/app/introspector/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/introspector/interfaces.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/introspector/interfaces.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
from zope.interface import Interface
class IIntrospector(Interface):
Modified: Zope3/trunk/src/zope/app/locales/extract.py
===================================================================
--- Zope3/trunk/src/zope/app/locales/extract.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/locales/extract.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -17,6 +17,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import os, sys, fnmatch
import time
import tokenize
@@ -135,14 +137,14 @@
file.close()
class TokenEater(object):
- """This is almost 100% taken from pygettext.py, except that I
+ """This is almost 100% taken from `pygettext.py`, except that I
removed all option handling and output a dictionary.
>>> eater = TokenEater()
>>> make_escapes(0)
TokenEater eats tokens generated by the standard python module
- tokenize.
+ `tokenize`.
>>> import tokenize
>>> from StringIO import StringIO
@@ -283,7 +285,7 @@
return files
def py_strings(dir, domain="zope"):
- """Retrieve all Python messages from dir that are in the domain.
+ """Retrieve all Python messages from `dir` that are in the `domain`.
"""
eater = TokenEater()
make_escapes(0)
@@ -307,7 +309,7 @@
return eater.getCatalog()
def zcml_strings(dir, domain="zope"):
- """Retrieve all ZCML messages from dir that are in the domain.
+ """Retrieve all ZCML messages from `dir` that are in the `domain`.
"""
from zope.app.appsetup import config
import zope
@@ -318,7 +320,7 @@
return context.i18n_strings.get(domain, {})
def tal_strings(dir, domain="zope", include_default_domain=False):
- """Retrieve all TAL messages from dir that are in the domain.
+ """Retrieve all TAL messages from `dir` that are in the `domain`.
"""
# We import zope.tal.talgettext here because we can't rely on the
# right sys path until app_dir has run
Modified: Zope3/trunk/src/zope/app/locales/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/app/locales/interfaces.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/locales/interfaces.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -15,6 +15,7 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
from zope.interface import Interface
@@ -40,7 +41,7 @@
"""
def add(strings, base_dir=None):
- """Add strings to the internal catalog.
+ """Add `strings` to the internal catalog.
"""
def write():
Modified: Zope3/trunk/src/zope/app/locales/pygettext.py
===================================================================
--- Zope3/trunk/src/zope/app/locales/pygettext.py 2004-08-04 04:34:55 UTC (rev 26891)
+++ Zope3/trunk/src/zope/app/locales/pygettext.py 2004-08-04 05:10:21 UTC (rev 26892)
@@ -138,6 +138,8 @@
$Id$
"""
+__docformat__ = 'restructuredtext'
+
import os
import sys
import time
More information about the Zope3-Checkins
mailing list