[SciPy-Dev] "Census" of scipy docstrings needing editing attention

[josef.pktd at gmail.com]

On Tue, May 4, 2010 at 6:54 PM, David Goldsmith <d.l.goldsmith at gmail.com> wrote:
> Hi, all.  Joe asked me to prepare this, and I thought it might be of
> "universal" interest to those working on the docs.  Following each milestone
> is the number of docstrings therein needing editing attention, i.e., in
> either the "Needs editing" or the "Being Written" state (based solely on
> their background color), as of today, May 4, 2010.
>
> All docstring from http://docs.scipy.org/scipy/docs/. 2584
>
> Milestones/Milestones_1 Cluster, Constants 54
>
> Milestones/Milestones_2 FFT, Integration 58
>
> Milestones/Milestones_3 Interpolation 77
>
> Milestones/Milestones_4 Input / Output 254 (most in io.matlab)
>
> Milestones/Milestones_5 Blas, Linear Algebra 130
>
> Milestones/Milestones_6 Max. Entropy, Misc., Image Manip. 173
>
> Milestones/Milestones_7 Ortho. dist. regr., Optimization 100
>
> Milestones/Milestones_8 Signal processing 119
>
> Milestones/Milestones_9 Sparse Matrices 325
>
> Milestones/Milestones_10 Spatial Algorithms., Special funcs. 266
>
> Milestones/Milestones_11 Statistical functions 473

I copied some depreciation warnings into the docstrings and changed
them to unimportant, e.g

http://docs.scipy.org/scipy/docs/scipy.stats.stats.mean/

What's the format for a warning/admonition directive and for
update/changes/removal notices?

Josef

>
> Milestones/Milestones_12 Image Array Manipulation, Convolution 47
>
> Milestones/Milestones_13 C/C++ Integration 508
>
> FWIW,
>
> DG
>
> --
> Mathematician: noun, someone who disavows certainty when their uncertainty
> set is non-empty, even if that set has measure zero.
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>
>