[Numpy-discussion] numpydoc: "Other Parameters" section

josef.pktd@gmai... josef.pktd@gmai...
Thu Sep 30 14:41:08 CDT 2010


On Thu, Sep 30, 2010 at 3:13 PM, Michael Droettboom <mdroe@stsci.edu> wrote:
> Is the solution as simple as the attached diff?  It works for me, but I
> don't understand all the implications.

just minor point
using "title" might be better now

>>> 'other parameters'.capitalize()
'Other parameters'

>>> 'other parameters'.title()
'Other Parameters'

(I would say looks ok to me, except I never looked much at the code.)

Thanks,

Josef

>
> Mike
>
> On 09/29/2010 06:52 PM, Joe Harrington wrote:
>>>
>>> It seems that the "Other parameters" section is not
>>> getting included in the output.
>>>
>>
>> The "Other parameters" is not often used in numpy because there are
>> not generally dozens of "tweaking" parameters in its basic numerical
>> routines.  It will probably be more common in certain scipy pages, and
>> if other packages adopted the format, it could get used a lot.
>> Plotting packages, for example, often have a ton of "tweaking"
>> parameters (line width, line color, line pattern, major axis tick
>> interval, minor axis tick interval, x axis label, y axis label, title,
>> axis font, title font, tick strings, etc.) and could use this section
>> to good effect to sort those out from the parameters of primary
>> interest.  This would keep the output section and so forth near the
>> top of the docstring for easy reading.
>>
>> So, it would be better to fix the problem than deprecate the section.
>>
>> --jh--
>> _______________________________________________
>> NumPy-Discussion mailing list
>> NumPy-Discussion@scipy.org
>> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>>
>
>
> --
> Michael Droettboom
> Science Software Branch
> Space Telescope Science Institute
> Baltimore, Maryland, USA
>
>
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion@scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
>


More information about the NumPy-Discussion mailing list