[SciPy-Dev] Status of scipy.* docstrings

David Goldsmith d.l.goldsmith@gmail....
Thu Aug 5 03:17:16 CDT 2010


OK, so, should I stop adding autosummaries to module docstrings and revert
the ones I did?

DG

On Mon, Aug 2, 2010 at 6:11 AM, Scott Sinclair
<scott.sinclair.za@gmail.com>wrote:

> On 2 August 2010 13:24, Pauli Virtanen <pav@iki.fi> wrote:
> > Mon, 02 Aug 2010 12:34:24 +0200, Scott Sinclair wrote:
> > [clip]
> >> Maybe the http://docs.scipy.org/scipy/docs/scipy.<subpackage>/
> >> docstrings should also be marked as unimportant to warn people that the
> >> situation is a little tricky to unravel..
> >
> > A valid alternative is just to put all of the documentation to the
> > info.py, and just put
> >
> >        .. automodule:: scipy.optimize
> >
> > to the optimize.rst.
>
> This is the approach I prefer as well. I tried to suggest it the last
> time we had this discussion
> (http://mail.scipy.org/pipermail/scipy-dev/2010-June/015075.html).
> Then there is only one place to keep the docs up to date, the downside
> being that a bit of Sphinx markup will be seen in the terminal help
> for sub-packages.
>
> The question is whether there actually is a strong aversion to seeing
> Sphinx markup in the terminal help at the top-level of the
> sub-packages. If it doesn't bother too many people, then your
> suggestion is the right way to go for all of the Scipy sub-packages.
>
> Cheers,
> Scott
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>



-- 
Mathematician: noun, someone who disavows certainty when their uncertainty
set is non-empty, even if that set has measure zero.

Hope: noun, that delusive spirit which escaped Pandora's jar and, with her
lies, prevents mankind from committing a general suicide.  (As interpreted
by Robert Graves)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100805/cf4edc58/attachment.html 


More information about the SciPy-Dev mailing list