[Numpy-discussion] Tests and code documentation

Alan G Isaac aisaac at american.edu
Thu Sep 21 18:58:31 CDT 2006


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 definition list style for consolidated field 
lists in section 5.1 of
http://epydoc.sourceforge.net/fields.html#rst
which is much more elegant, IMO.

Cheers,
Alan Isaac








More information about the Numpy-discussion mailing list