docstrings style question
Jeroen Ruigrok van der Werven
asmodai at in-nomine.org
Thu Jan 10 03:11:03 EST 2008
-On [20080110 06:51], Steve Brown (steve at mhomer.au) wrote:
>I don't like the duplicated information: But the comment is attractive,
I find it unattractive to be honest.
>and the docstring self.__doc__ is already in use in the test log. I've read
>that all modules and classes should have docstrings, but I don't really have
>anything else to say, and each module contains only one class.
The ultimate test is running `pydoc your.module` or running epydoc on your
source and see how well the resulting documentation is built up.
--
Jeroen Ruigrok van der Werven <asmodai(-at-)in-nomine.org> / asmodai
イェルーン ラウフロック ヴァン デル ウェルヴェン
http://www.in-nomine.org/ | http://www.rangaku.org/
The quieter you become, the more you are able to hear...
More information about the Python-list
mailing list