[SciPy-dev] Module level docstrings

Tim Leslie tim.leslie at gmail.com
Wed Mar 15 21:44:09 CST 2006


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?

Cheers,

Timl
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://projects.scipy.org/pipermail/scipy-dev/attachments/20060316/ea5770ec/attachment.html 


More information about the Scipy-dev mailing list