[Numpy-discussion] Tests and code documentation

Charles R Harris charlesr.harris at gmail.com
Thu Sep 21 11:42:59 CDT 2006


On 9/21/06, Sebastian Haase <haase at msg.ucsf.edu> 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
> > such tests?
> >
> > 2) Any plans for code documentation? I documented some of my stuff with
> > doxygen markups and wonder if we should include a Doxyfile as part of
> the
> > package.
>
> 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 func():
    pass


Looks like ## replaces the /**

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://projects.scipy.org/pipermail/numpy-discussion/attachments/20060921/71d98e9e/attachment.html 


More information about the Numpy-discussion mailing list