[SciPy-dev] Docstring standards for NumPy and SciPy

Travis Oliphant oliphant at ee.byu.edu
Mon Jan 22 16:20:43 CST 2007


David Huard wrote:

> I tried to run epydoc on the example described in the wiki Jarrod 
> created last week, and there are some things that don't quite work.
>
> 1. The examples  section appear before the parameters and Return 
> values, which looks strange. I tried to fix this by adding an 
> :example: field to epydoc, but then the output doesn't look so good.
>
> 2. The output format of return values and parameters look different in 
> the pdf.


Epydoc needs some changes in order to "do the right" thing with the 
docstrings.   This is known.  I think the changes are minor.

-Travis



More information about the Scipy-dev mailing list