[SciPy-dev] [Numpy-discussion] Doc-day

Fernando Perez fperez.net@gmail....
Thu Dec 27 23:57:14 CST 2007


On Dec 27, 2007 10:50 PM, Jarrod Millman <millman@berkeley.edu> wrote:

> > I also think that the above wiki page should have a minimal,
> > self-contained example of a proper docstring with all 8 sections
> > implemented.  I'm honestly not sure at this point what the actual
> > changes to epydoc are (in ipython we use regular epydoc with reST),
> > and I think for many it would be much easier to get started by reading
> > a small example rather than trying to abstract out what the exact
> > markup should be from reading the description and the various
> > documents linked to (doctest, reST, epydoc...).
>
> I think we already have that.  Take a look at the example at the bottom:
> http://projects.scipy.org/scipy/numpy/wiki/CodingStyleGuidelines#example

Oops, sorry.  I read the page quickly and my brain was scanning for a
big block of text in {{{ }}}, so I didn't look at that section
carefully enough.   My mistake.

Cheers,

f


More information about the Scipy-dev mailing list