docstrings

Sam Penrose sam at ddmweb.com
Fri Jun 1 01:43:09 CEST 2001


> Our existing docstrings, written exaclty the way we have been
> coding together every day of our lives for the last decade
> do not work here.  But that is because in the crash course of
> learn python in a month or 6, none of us had read about docstrings
> until I did the day before yesterday.

..your docstrings do not work?
..what do you mean by 'work'?
..what do you want them to do?

..A docstring works if it documents something well.

<http://www.python.org/doc/essays/styleguide.html>
The section on doc strings comes after those on comments.

Also, <http://web.pydoc.org/>. Using pydoc, which comes with 2.1, 

>>> from pydoc import help
>>> help(foo) 




More information about the Python-list mailing list