changeset 36:fe43d37ca0ef

docstrings: fix some typos in field names / field syntax
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Mon, 28 Feb 2011 03:29:59 +0100
parents bd7ddd27cd8e
children 74a543f57ce7
files MoinMoin/app.py MoinMoin/converter/_wiki_macro.py MoinMoin/search/results.py MoinMoin/storage/__init__.py
diffstat 4 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/MoinMoin/app.py	Mon Feb 28 03:22:43 2011 +0100
+++ b/MoinMoin/app.py	Mon Feb 28 03:29:59 2011 +0100
@@ -54,7 +54,7 @@
                               otherwise it'll use MOINCFG from flask config. If that
                               also is not there, it'll use the DefaultConfig built
                               into MoinMoin.
-    @oaram warn_default: emit a warning if moin falls back to its builtin default
+    @param warn_default: emit a warning if moin falls back to its builtin default
                          config (maybe user forgot to specify MOINCFG?)
     @param **kwargs: if you give additional key/values here, they'll get patched
                      into the moin configuration class (before it instance is created)
--- a/MoinMoin/converter/_wiki_macro.py	Mon Feb 28 03:22:43 2011 +0100
+++ b/MoinMoin/converter/_wiki_macro.py	Mon Feb 28 03:29:59 2011 +0100
@@ -136,7 +136,7 @@
         """
         Should be overriden to format text in some macros according to the
         input type.
-        @return Sequence of (ET.Element, unicode)
+        @return: Sequence of (ET.Element, unicode)
         """
         return [text]
 
--- a/MoinMoin/search/results.py	Mon Feb 28 03:22:43 2011 +0100
+++ b/MoinMoin/search/results.py	Mon Feb 28 03:29:59 2011 +0100
@@ -276,7 +276,7 @@
         @param formatter: formatter to use
         @param hitsFrom: current position in the hits
         @rtype: unicode
-        @return formatted statistics
+        @return: formatted statistics
         """
         if not self.estimated_hits:
             self.estimated_hits = ('', len(self.hits))
@@ -313,7 +313,7 @@
         @param hitsFrom: current position in the hits
         @param hitsInfo: toggle hits info line
         @rtype: unicode
-        @return formatted page list
+        @return: formatted page list
         """
         self._reset(request, formatter)
         f = formatter
@@ -394,7 +394,7 @@
         @param hitsFrom: current position in the hits
         @param hitsInfo: toggle hits info line
         @rtype: unicode
-        @return formatted page list with context
+        @return: formatted page list with context
         """
         self._reset(request, formatter)
         f = formatter
--- a/MoinMoin/storage/__init__.py	Mon Feb 28 03:22:43 2011 +0100
+++ b/MoinMoin/storage/__init__.py	Mon Feb 28 03:29:59 2011 +0100
@@ -665,7 +665,7 @@
 
         @type key: str or unicode
         @param key: The key refering to the value we want to return.
-        @return self._metadata[key]
+        @return: self._metadata[key]
         """
         self._read_accessed = True
         if not isinstance(key, (unicode, str)):