[Numpy-discussion] Documentation errors

Charles R Harris charlesr.harris at gmail.com
Sat May 14 13:13:18 EDT 2011


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)
>
> on the first line of the docstrings. The autosummary part tries to
> truncate the argument list if it is too long, but its parser chokes on
> the nonstandard syntax.
>
>
Looks like we also need to add the new keywords. There are a lot of them.



> > Also, what is the easiest way to generate the reference guide for
> > testing purposes?
>
> cd doc
> export PYTHONPATH=wherever-you-installed-numpy
> make html
>
> or just
>
> make dist
>
>
Thanks.

<snip>

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20110514/814778eb/attachment.html>


More information about the NumPy-Discussion mailing list