[SciPy-dev] Module level docstrings
Robert Kern
robert.kern at gmail.com
Wed Mar 15 22:46:30 EST 2006
Tim Leslie wrote:
> Looking through the code for both numpy and scipy, there are lots of
> cases where modules have header comments of the form:
>
> #
> # This is the foobar module for doing stuff. <insert useful information
> about foobar here>
> #
>
> Rather than having these blocks as comments, would it be worth changing
> them to be docstrings so they could be parsed by tools like pydoc and
> doxygen?
Yes! Thank you!
--
Robert Kern
robert.kern at gmail.com
"I have come to believe that the whole world is an enigma, a harmless enigma
that is made terrible by our own mad attempt to interpret it as though it had
an underlying truth."
-- Umberto Eco
More information about the SciPy-Dev
mailing list