Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Alan G Isaac
On Thu, 21 Sep 2006, Charles R Harris apparently wrote: > As to the oddness of \param or @param, here is an example from > Epydoc using Epytext > @type m: number > @param m: The slope of the line. > @type b: number > @param b: The y intercept of the line. Compare to defini

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Alan G Isaac
On Thu, 21 Sep 2006, "David M. Cooke" apparently wrote: > Foremost for Python doc strings, I think, is that it look > ok when using pydoc or similar (ipython's ?, for > instance). That means a minimal amount of markup. IMO reStructuredText is very natural for documentation, and it is nicely ha

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Charles R Harris
Hi, On 9/21/06, Robert Kern <[EMAIL PROTECTED]> wrote: Steve Lianoglou wrote:> So .. I guess I'm wondering why we want to break from the standard?We don't as far as Python code goes. The code that Chuck added Doxygen-stylecomments to was C code. I presume he was simply answering Sebastian's questio

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Robert Kern
Steve Lianoglou wrote: > So .. I guess I'm wondering why we want to break from the standard? We don't as far as Python code goes. The code that Chuck added Doxygen-style comments to was C code. I presume he was simply answering Sebastian's question rather than suggesting we use Doxygen for Pytho

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread David M. Cooke
On Thu, 21 Sep 2006 10:05:58 -0600 "Charles R Harris" <[EMAIL PROTECTED]> wrote: > Travis, > > A few questions. > > 1) I can't find any systematic code testing units, although there seem to be > tests for regressions and such. Is there a place we should be putting such > tests? > > 2) Any plans

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Steve Lianoglou
> Are able to use doxygen for Python code ? I thought it only worked > for C (and > alike) ? > > IIRC correctly, it now does Python too. Let's see... here is an > example > ## Documentation for this module. > # > # More details. > > ## Documentation for a function. > # > # More details. > def f

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Charles R Harris
On 9/21/06, Sebastian Haase <[EMAIL PROTECTED]> wrote: On Thursday 21 September 2006 09:05, Charles R Harris wrote:> Travis,>> A few questions.>> 1) I can't find any systematic code testing units, although there seem to> be tests for regressions and such. Is there a place we should be putting > suc

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Louis Cordier
> Are able to use doxygen for Python code ? I thought it only worked for C (and > alike) ? There is an ugly-hack :) http://i31www.ira.uka.de/~baas/pydoxy/ But I wouldn't recommend using it, rather stick with Epydoc. -- Louis Cordier <[EMAIL PROTECTED]> cell: +27721472305 Point45 Entertainment

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Travis Oliphant
Charles R Harris wrote: > Travis, > > A few questions. > > 1) I can't find any systematic code testing units, although there seem > to be tests for regressions and such. Is there a place we should be > putting such tests? All tests are placed under the tests directory of the corresponding sub-pa

Re: [Numpy-discussion] Tests and code documentation

2006-09-21 Thread Sebastian Haase
On Thursday 21 September 2006 09:05, Charles R Harris wrote: > Travis, > > A few questions. > > 1) I can't find any systematic code testing units, although there seem to > be tests for regressions and such. Is there a place we should be putting > such tests? > > 2) Any plans for code documentation?

[Numpy-discussion] Tests and code documentation

2006-09-21 Thread Charles R Harris
Travis,A few questions.1) I can't find any systematic code testing units, although there seem to be tests for regressions and such. Is there a place we should be putting such tests?2) Any plans for code documentation? I documented some of my stuff with doxygen markups and wonder if we should includ