[SciPy-dev] Doc-ing classes and data attributes

Ralf Gommers ralf.gommers@googlemail....
Sun Jun 21 19:59:39 CDT 2009


2009/6/21 Stéfan van der Walt <stefan@sun.ac.za>

> 2009/6/21 Ralf Gommers <ralf.gommers@googlemail.com>:
> > The CodingStyleGuidelines page is generated from
> > /trunk/doc/HOWTO_DOCUMENT.txt so editing on Trac is not what you want.
> The
> > page is already in reST format, so can we add it to the doc editor and
> edit
> > it there?
>
> The documentation standard should not be open to editing.  You are, of
> course, welcome to provide patches that we can apply after discussion,
> but this document cannot be in a state of flux.


You're right that it should not be in a state of flux. I attached a patch to
#1146 for review.

I suggested the wiki because there needs to be a place where design
decisions that are taken on mailing list or in doc editor comments can be
collected and reviewed. Maybe we can have such a page on the wiki, and then
after some collaborative editing and everyone agreeing, coming up with a
patch for /trunk/doc/HOWTO_DOCUMENT.txt (which should be the gold standard).

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20090621/523eacae/attachment.html 


More information about the Scipy-dev mailing list