[SciPy-Dev] Checkin checklist

[David Goldsmith]

+1  Only one comment: the docstring Standard says this about the Examples
section:

"...While optional, this section is very strongly encouraged."

IMHO, this is too weak when the object in question is a function, so I would
"very strongly encourage" you to add to Item 2 something to the effect of:

"...have accurate docstrings that conform to the scipy documentation
standard, including example(s) if the object is a function."

I'd really like to see every function have at least one example. :-)

DG

On Sat, May 29, 2010 at 6:29 PM, Matthew Brett <matthew.brett at gmail.com>wrote:

> Hi,
>
> On Sat, May 29, 2010 at 5:58 PM, Warren Weckesser
> <warren.weckesser at enthought.com> wrote:
> > Here's a first shot at a checklist to use when working on scipy.
> > Something like this should be in the development section of the wiki.
> > What do you think?
> >
> > Checkin checklist:
> >
> > * Have you created tests for the new functionality, and have you run
> >  all the module's tests to ensure you haven't broken something else?
> >
> > * Do all the affected classes, methods, and functions have accurate
> >  docstrings that conform to the scipy documentation standard?
> >
> > * Have you updated the module-level documentation?
> >  There are (usually) two relevant files:
> >  * scipy/some_package/info.py
> >  * doc/source/some_package.rst
> >
> > * Have you updated the release notes? (doc/release/0.8.0-notes.rst)
> >  Any API changes (new stuff, changed stuff, deprecations, etc)
> >  should be noted in the release notes.
> >
> > * If the changes affect a tutorial, have you updated the tutorial?
> >  The tutorials are in doc/source/tutorial.
>
> Ouch - good call.  These sound like a very reasonable list to me.
>
> Have we got anything like a sub-package maintainers list?   Obviously
> I'm good for at least scipy.io.matlab...
>
> Thanks a lot,
>
> Matthew
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at 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.python.org/pipermail/scipy-dev/attachments/20100529/16014ab8/attachment.html>