[Scipy-svn] r5255 - trunk/scipy/ndimage
scipy-svn at scipy.org
scipy-svn at scipy.org
Sun Dec 14 07:08:39 EST 2008
Author: matthew.brett at gmail.com
Date: 2008-12-14 06:08:36 -0600 (Sun, 14 Dec 2008)
New Revision: 5255
Modified:
trunk/scipy/ndimage/doccer.py
Log:
Further small docstrings for the doc formatting module
Modified: trunk/scipy/ndimage/doccer.py
===================================================================
--- trunk/scipy/ndimage/doccer.py 2008-12-14 12:04:36 UTC (rev 5254)
+++ trunk/scipy/ndimage/doccer.py 2008-12-14 12:08:36 UTC (rev 5255)
@@ -48,7 +48,15 @@
def filldoc(docdict):
''' Return docstring decorator using docdict variable dictionary
+ Parameters
+ ----------
+ docdict : dictionary
+ dictionary containing name, docstring fragment pairs
+ Returns
+ -------
+ decfunc : function
+ decorator that applies dictionary to input function docstring
'''
def decorate(f):
f.__doc__ = docformat(f.__doc__, docdict)
More information about the Scipy-svn
mailing list