[SciPy-user] Docstring standards for NumPy and SciPy

Travis Oliphant oliphant at ee.byu.edu
Wed Jan 17 18:12:40 CST 2007


Fernando Perez wrote:

>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.
>  
>
I'm a little woried that epydoc is using :Keywords:  differently here as 
in: these are keywords for the function that should go into some kind of 
index.

-Travis



More information about the SciPy-user mailing list