[SciPy-user] Docstring standards for NumPy and SciPy

Perry Greenfield perry at stsci.edu
Thu Jan 11 11:27:15 EST 2007


On Jan 11, 2007, at 10:58 AM, Brian Granger wrote:

>
> Because of this, and the reasons that Fernando listed (too much
> cognitive load in tracking all the different markup languages already)
> we are using epydoc+ReST in IPython from now forward.
>
> I realize that the line noise of ReST is less readable in Terminal
> based things, but I feel it is a nice compromise for the
> capabilities/features that you get.

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?

Perry





More information about the SciPy-User mailing list