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

josef.pktd@gmai... josef.pktd@gmai...
Wed Sep 29 15:56:35 CDT 2010


On Wed, Sep 29, 2010 at 4:39 PM,  <josef.pktd@gmail.com> wrote:
> On Wed, Sep 29, 2010 at 4:19 PM, Charles R Harris
> <charlesr.harris@gmail.com> wrote:
>>
>>
>> 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.
>
> http://code.google.com/p/pydocweb/issues/detail?id=45
>
> and scipy-dev mailinglist around March 18

We discussed the same problem with Other Parameters, which is also a
(independent ?) problem in the doc editor.

But browsing the thread and ticket, I don't see any solution.

Josef

>
> Josef
>
>> Chuck.
>>
>>
>> _______________________________________________
>> NumPy-Discussion mailing list
>> NumPy-Discussion@scipy.org
>> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>>
>>
>


More information about the NumPy-Discussion mailing list