[SciPy-user] Docstring standards for NumPy and SciPy

Fernando Perez fperez.net at gmail.com
Tue Jan 16 13:42:44 CST 2007


On 1/16/07, Edward Loper <edloper at gradient.cis.upenn.edu> wrote:

[...]

many thanks for your feedback, Ed.  This is a sorely needed
development in scipy's growth.


> [Perry Greenfield]
>
> > Any reason ipython can't use epydoc or some other tool to format the
> > markup in ascii (I forget if epydoc does ascii output) so that the
> > user doesn't see the 'line noise' when using the ipython
> > introspection features?
> >
>
> If you add this to ipython, please be sure to check the __docformat__
> variable before deciding how to convert the docstring!  (If you
> encounter an unknown markup, then just render it as plaintext.)

No worries, that's how it will be done.

Cheers,

f


More information about the SciPy-user mailing list