docstrings style question

Steve Brown steve at mhomer.au
Thu Jan 10 06:47:40 CET 2008


I've got a series of modules which look like this:

#************
#
# Temperature Sense Test
#
#************
class Test3(ar_test.AR_TEST):
    """Temperature Sense Test"""


I don't like the duplicated information: But the comment is attractive, 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. I don't think 
that

"""Temperature Sense Test"""
class Test3(ar_test.AR_TEST):
    """Temperature Sense Test"""

would be a real improvement.

What do you think?

Steve.





More information about the Python-list mailing list