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

Joe Harrington jh@physics.ucf....
Wed Sep 29 17:52:21 CDT 2010

> 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.


More information about the NumPy-Discussion mailing list