[Scipy-svn] r5254 - trunk/scipy/ndimage

[scipy-svn at scipy.org]

Author: matthew.brett at gmail.com
Date: 2008-12-14 06:04:36 -0600 (Sun, 14 Dec 2008)
New Revision: 5254

Modified:
   trunk/scipy/ndimage/doccer.py
Log:
Some more docstrings for the doc formatting module

Modified: trunk/scipy/ndimage/doccer.py
===================================================================
--- trunk/scipy/ndimage/doccer.py	2008-12-14 11:51:37 UTC (rev 5253)
+++ trunk/scipy/ndimage/doccer.py	2008-12-14 12:04:36 UTC (rev 5254)
@@ -1,9 +1,26 @@
 import sys
 
 def docformat(docstring, docdict=None):
-    ''' Fill a function docstring from variables in dict
+    ''' Fill a function docstring from variables in dictionary
 
     Adapt the indent of the inserted docs
+
+    Parameters
+    ----------
+    docstring : string
+        docstring from function, possibly with dict formatting strings
+    docdict : dict
+        dictionary with keys that match the dict formatting strings
+        and values that are docstring fragments to be inserted.  The
+        indentation of the inserted docstrings is set to match the
+        indentation of the ``docstring``.  The string values in the
+        docdict are assumed to have no indent in the first line, and
+        only indent relative to the first line for following lines.
+
+    Returns
+    -------
+    outstring : string
+        string with any formatted strings inserted
     '''
     if not docstring:
         return docstring
@@ -29,7 +46,10 @@
 
 
 def filldoc(docdict):
-    ''' Return docstring decorator using docdict variable dictionary'''
+    ''' Return docstring decorator using docdict variable dictionary
+
+
+    '''
     def decorate(f):
         f.__doc__ = docformat(f.__doc__, docdict)
         return f