Re: docstrings style question

2008-01-10 Thread Steve Brown
What I'm trying to do with the tests is pare them back so that the code explicitly and concisely documents the tests. It is important that the comments and doc strings NOT contain information about how Temperature Sense works because that is outside the scope of the test. More generally, comments

Re: docstrings style question

2008-01-10 Thread Steve Brown
"Neil Cerutti" <[EMAIL PROTECTED]> wrote in message news:[EMAIL PROTECTED] > On Jan 10, 2008 12:47 AM, Steve Brown <[EMAIL PROTECTED]> wrote: >> I've got a series of modules which look like this: >> >> # >> # >> #

Re: docstrings style question

2008-01-10 Thread Steve Brown
"Russ P." <[EMAIL PROTECTED]> wrote in message news:[EMAIL PROTECTED] > On Jan 9, 11:51 pm, Fredrik Lundh <[EMAIL PROTECTED]> wrote: >> Steve Brown wrote: >> > I've got a series of modules which look like this: >> >

docstrings style question

2008-01-09 Thread Steve Brown
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