[SciPy-user] Docstring standards for NumPy and SciPy

Fernando Perez fperez.net at gmail.com
Wed Jan 17 18:02:08 CST 2007


On 1/17/07, Travis Oliphant <oliphant at ee.byu.edu> wrote:

> Personally I'd like to use :Parameters: and then add an :Extra
> Parameters: section or something like that if just using a blank-line in
> the :Parameters: section is not useful enough.

Glad to hear that :)

I'd suggest 'Optional Parameters' or 'Named Parameters' if the
existing 'Keywords' convention that epydoc/reST uses isn't deemed
satisfactory (I happen to be OK with 'Keywords', but that's just me).
I find the word 'Extra' rather vague and void of real meaning in this
case.

Cheers,

f


More information about the SciPy-user mailing list