[Numpy-discussion] Docstring page, out of date?

Jarrod Millman millman@berkeley....
Mon Jan 21 19:09:27 CST 2008


On Jan 21, 2008 2:03 PM, Matthew Brett <matthew.brett@gmail.com> wrote:
> Search for the docstring standard, I hit this:
>
> http://www.scipy.org/DocstringStandard

Good catch, I didn't know this page existed.  If I recall correctly,
Keir Mierle showed up on the mailing list around the time we were
discussing the docstring standard.  He proposed to do some work, but
then must have gotten busy with something else.  In particular, I
believe he was interested in seeing a unified docstring standard for
numpy, scipy, and matplotlib.  I guess he put this page up during that
period.  I went ahead and deleted it, since it conflicts with the
official docstring standard.

> but I think the current thinking is this:
>
> http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines
>
> Is that correct? Does the first page apply to matplotlib in some way?
> Should we change the first page to match the second now?

Yes.  That page is autogenerated from the official coding standard
that is in the numpy trunk.  One of the nice features of trac is that
it can render restructured text from the svn repository.  This helps
us keep from having duplicate information that needs to be kept in
sync by hand.

Thanks,

-- 
Jarrod Millman
Computational Infrastructure for Research Labs
10 Giannini Hall, UC Berkeley
phone: 510.643.4014
http://cirl.berkeley.edu/


More information about the Numpy-discussion mailing list