[SciPy-Dev] Status of scipy.* docstrings

David Goldsmith d.l.goldsmith@gmail....
Sat Jul 31 23:18:30 CDT 2010


Hi, folks!  Except for scipy.stats, the docstrings of all sub-packages
immediately "below" scipy have now had autosummary directives for all (with
one exception) their objects added to them, with either the existing
description if there already was one, or the description pulled in by the
autosummary (perhaps paraphrased if necessary to satisfy the 75 character
restriction) if said pulling worked, or "TODO" if neither of those
conditions were met; scipy.stats was already partially under autosummary
"control" when I checked it, so I've left it alone pending further info as
to whether this incompleteness is intentional or not.  I will continue to
work my way down the namespace tree - at a reduced pace - but I just wanted
to announce that this *ad hoc* (i.e., "unofficial") milestone has been met,
and point out that some of the holes alluded to above can serve as pointers
to places that need work, e.g., places where the autosummary directive
either pulled nothing, "failed to parse" the summary, or pulled an
excessively long description (indicating, IIUC, a docstring w/ an
excessively long Brief Summary).

Thanks for all you do (and thanks for all the kudos that have come in post
my resignation announcement).

DG

-- 
Mathematician: noun, someone who disavows certainty when their uncertainty
set is non-empty, even if that set has measure zero.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20100731/4958973d/attachment.html 


More information about the SciPy-Dev mailing list