[SciPy-Dev] Update on the "Needs editing" numpy docstrings

[Ralf Gommers]

On Thu, Apr 29, 2010 at 2:24 PM, David Goldsmith <d.l.goldsmith at gmail.com>wrote:

> Hi, all!  I've been working on the remaining "Needs editing" status numpy
> docstrings, of which there are presently 74.  I've compiled two lists: those
> I think might be classifiable as "Unimportant," and those I think might
> require somewhat lengthy docstrings (the latter list is meant to try to
> recruit helpers). ;-)  Here are those lists:
>

Hi David, thanks for the update.

Except for polytemplate.rel_import (which someone already moved to
unimportant) I think all of these still need to be written. They are all
useful, so don't move them. For the ones no one with the right expertise has
time for, just leave them as they are - at some point the blanks will be
filled in.

Cheers,
Ralf


>     List of potentially "Unimportant"s
> timeinteger (autogenerated subclass of signedinteger)
> timedelta64 (autogenerated subclass of timeinteger)
> polytemplate.rel_import
> Everything in distutils that still has status "Needs editing"
> linalg (docstring - which consists of tables of objects - auto-generated?)
> lib.shape_base.get_array_wrap
> f2py.diagnose and its "Needs editing" status attributes
> numpy.lib._iotools.StringConverter.iterupgrade
> dtype.base and dtype.metadata
>
>     List of potentially "long" ones
> All "Needs editing" status doc.*
> core.umath, core.shape_base, core.function_base
> numpy-docs/*
>
> If you have opinions on these (or if you look at the whole list of
> remaining "Needs editing" docstrings and feel that I've left some off the
> "Unimportant" list) please do chime in.
>
> Thanks,
>
> 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
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20100505/078cab30/attachment.html>