[SciPy-Dev] Strange truncation of autosummary docstring

Warren Weckesser warren.weckesser at enthought.com
Sat Jan 14 22:13:31 EST 2012


I just added the rosenbrock functions to the `optimize` module docstring in
optimize/__init__.py.  When I rebuild the docs, the optimize page (which is
html output of the docstring in __init__.py) shows this for rosen_der:

    rosen_der(x) The derivative (i.e.

It should be

rosen_der(x) The derivative (i.e. gradient) of the Rosenbrock function.

The text after 'rosen_der(x)' should be the first line of the docstring.

Is the truncation because of some cleverness in the numpydoc sphinx
extension?

Warren
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20120114/f405e071/attachment.html>


More information about the SciPy-Dev mailing list