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

2008-01-22 Thread David Cournapeau
On Jan 22, 2008 3:18 PM, Jarrod Millman [EMAIL PROTECTED] wrote: On Jan 21, 2008 7:56 PM, Charles R Harris [EMAIL PROTECTED] wrote: On Jan 21, 2008 8:38 PM, Charles R Harris [EMAIL PROTECTED] wrote: If I hit the source code link in the generated html, it looks like that page was generated

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

2008-01-22 Thread Hans Meine
Am Dienstag, 22. Januar 2008 07:27:19 schrieb Robert Kern: The new document format requires a preprocessor that has yet to be written. epydoc from SVN works just fine once the following line is added at the top. __docformat__ = restructuredtext en No need to clutter the files, just use

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

2008-01-21 Thread Matthew Brett
Hi, Search for the docstring standard, I hit this: http://www.scipy.org/DocstringStandard 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

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

2008-01-21 Thread Jarrod Millman
On Jan 21, 2008 2:03 PM, Matthew Brett [EMAIL PROTECTED] 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

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

2008-01-21 Thread Charles R Harris
On Jan 21, 2008 6:09 PM, Jarrod Millman [EMAIL PROTECTED] wrote: On Jan 21, 2008 2:03 PM, Matthew Brett [EMAIL PROTECTED] 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,

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

2008-01-21 Thread Charles R Harris
On Jan 21, 2008 8:38 PM, Charles R Harris [EMAIL PROTECTED] wrote: On Jan 21, 2008 6:09 PM, Jarrod Millman [EMAIL PROTECTED] wrote: On Jan 21, 2008 2:03 PM, Matthew Brett [EMAIL PROTECTED] wrote: Search for the docstring standard, I hit this: http://www.scipy.org/DocstringStandard

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

2008-01-21 Thread Robert Kern
David Cournapeau wrote: Nobody likes to write doc, specially if you have to follow many rules. Not being able to see the result does not help. I don't know much about the current documation tools situation with python, but I have seen good, automatically generated doc for python modules: for

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

2008-01-21 Thread Jarrod Millman
On Jan 21, 2008 7:56 PM, Charles R Harris [EMAIL PROTECTED] wrote: On Jan 21, 2008 8:38 PM, Charles R Harris [EMAIL PROTECTED] wrote: If I hit the source code link in the generated html, it looks like that page was generated from the old document format. The new document format doesn't

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

2008-01-21 Thread Charles R Harris
On Jan 21, 2008 11:27 PM, Robert Kern [EMAIL PROTECTED] wrote: Charles R Harris wrote: On Jan 21, 2008 6:09 PM, Jarrod Millman [EMAIL PROTECTED] mailto:[EMAIL PROTECTED] wrote: On Jan 21, 2008 2:03 PM, Matthew Brett [EMAIL PROTECTED] mailto:[EMAIL PROTECTED] wrote: