[Numpy-discussion] Finalising documentation guidelines for NumPy
Alan G Isaac
aisaac@american....
Tue Jul 17 12:58:24 CDT 2007
On Tue, 17 Jul 2007, Stefan van der Walt apparently wrote:
> var1 :
> Description.
> breaks. This can be fixed either by omitting the colon after
> 'var1' in the second case, or by slightly modifying epydoc's output.
It breaks semantically too, no?
(The colon is a separator, separating the variable name from its type.)
By the way,
Are you referring to a particular document? I see the
following document
http://projects.scipy.org/scipy/numpy/wiki/DocstringStandards
which points to the detailed document.
http://projects.scipy.org/scipy/numpy/browser/trunk/numpy/doc/HOWTO_DOCUMENT.txt
The detailed document seems the place to add your changes.
(Note that the renderred version is unavailable:
http://projects.scipy.org/scipy/numpy/wiki/HowToDocument)
Cheers,
Alan Isaac
More information about the Numpy-discussion
mailing list