[Numpy-discussion] Documentation errors

Ralf Gommers ralf.gommers at googlemail.com
Sun May 15 04:32:17 EDT 2011


On Sun, May 15, 2011 at 6:22 AM, Charles R Harris <charlesr.harris at gmail.com
> wrote:

>
>
> On Sat, May 14, 2011 at 10:48 AM, Pauli Virtanen <pav at iki.fi> wrote:
>
>> On Sat, 14 May 2011 09:45:12 -0600, Charles R Harris wrote:
>> [clip]
>> > These are generated by the .. autosummary:: command, so the error
>> > probably lies there.
>>
>> The problem is that the signature of these routines is written as
>>
>>        remainder(x1, x2[, out])
>>
>> and not as
>>
>>        remainder(x1, x2, out=None)
>>
>>
> OK, the format for that part of the signature is in line 4910 in
> ufunc_object.c. The question is, which should we fix, the format or the
> autosummary?
>
> The format please. That [, out] never made sense to me.

Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20110515/9b9c7e71/attachment.html>


More information about the NumPy-Discussion mailing list