[SciPy-dev] documenting objects in stats.distributions

Ralf Gommers ralf.gommers@googlemail....
Wed Dec 16 02:30:36 CST 2009


On Wed, Dec 16, 2009 at 3:58 PM, Christopher Burns <cburns@berkeley.edu>wrote:

> We're working on documentation at the SciPy.in sprints and have run
> into a strange documentation problem.  Several of the distributions
> are objects, not classes, so the documentation page gives a warning
> "Unknown section Methods".
>
> See:
> http://docs.scipy.org/scipy/docs/scipy.stats.alpha/
>
> Is there a way to update the docs to remove this warning?
>

No, to remove the warning pydocweb (the wiki app) should recognize the
Methods section in class instance docstrings I think.

A related point: the docstrings for the stats distributions are generated
from a template right now, so any edits for those docstrings in the doc wiki
can not be merged without a lot of tweaking. If you're also interested in
working on other areas of the scipy docs, that might be more effective.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20091216/d768b089/attachment.html 


More information about the SciPy-Dev mailing list