[SciPy-user] Docstring standards for NumPy and SciPy

Gael Varoquaux gael.varoquaux at normalesup.org
Fri Jan 12 10:53:18 CST 2007


On Fri, Jan 12, 2007 at 11:44:38AM -0500, Perry Greenfield wrote:
> 1) regarding having ipython process the docstring. I suppose that one  
> could argue that preprocessing the docstring universally may screw up  
> those not written for the markup language. Wouldn't it be possible to  
> put some sort of marker in the module (flag definition, e.g.,  
> ipdoc=True) so that ipython could check the module that the docstring  
> comes from to see if it should be preprocessed? Maybe this isn't  
> worth worrying about.

This already exists, a variable in the module can specify this to epydoc:

__docformat__ = "restructuredtext en"

See http://epydoc.sourceforge.net/othermarkup.html

Gaël 


More information about the SciPy-user mailing list