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

Charles R Harris charlesr.harris@gmail....
Wed Sep 29 15:19:40 CDT 2010


On Wed, Sep 29, 2010 at 1:59 PM, Michael Droettboom <mdroe@stsci.edu> wrote:

> We're having trouble using numpydoc formatted docstrings for one of our
> own project.  It seems that the "Other parameters" section is not
> getting included in the output.
>
> A grep across Numpy's own source code (git master) reveals that this
> kind of section is used in only one place -- the docstring for
> "recarray".  Curiously, the "Other Parameters" section is displayed in
> the documentation editor here:
>
>   http://docs.scipy.org/numpy/docs/numpy.core.records.recarray/
>
> But not in the generated Numpy docs online here:
>
>   http://docs.scipy.org/doc/numpy/reference/generated/numpy.recarray.html
>
> Is this a bug?
>
>
Probably. The Other Parameters section is one of those ideas that sounded
good at the time but didn't end up used in practice. I expect that nobody
noticed its absence before.

Chuck.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20100929/e5656c39/attachment.html 


More information about the NumPy-Discussion mailing list