Standard way of documenting python code ?
John J. Lee
jjl at pobox.com
Sun Nov 30 10:30:28 EST 2003
Rony <bucodi at ahoo.fr> writes:
> A question on python source documentation.
> Does there exist a standard for documenting code ?
> I've included here an example generated by pydoc of one of my modules.
> Is this the right way or is it overkill ?
> Comments are appreciated
[...]
http://www.python.org/peps/pep-0008.html
There are some good guidelines about docstrings in there.
If you're writing in English, error is spelled "error", not
"erreur". :-)
John
More information about the Python-list
mailing list