On Fri, 11 Jan 2008 13:09:26 +1100, Steve Brown wrote:
> What I'm trying to do with the tests is pare them back so that the code
> explicitly and concisely documents the tests.
Yes, this is good.
> It is important that the comments and doc strings NOT contain
> information about how Temperature
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
"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:
>>
>> #
>> #
>> # Temperature Sense Test
>> #
>> #
>> class Test3(ar_test.AR_
On Jan 10, 2008 12:47 AM, Steve Brown <[EMAIL PROTECTED]> wrote:
> 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
"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:
>>
>> > #
>> > #
>> > # Temperature Sense Test
>> > #
>> > #
>
Russ P. wrote:
> On Jan 9, 9:47 pm, "Steve Brown" <[EMAIL PROTECTED]> wrote:
>> 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
> On Behalf Of Steve Brown
> What do you think?
I think that comments are for maintainers, and docstrings are for users.
Some of the things I use comments for:
* Visually separate classes (using a syntax-highlighting editor)
* Explain algorithm choices
* Explain bug fixes so I don't later "fix"
-On [20080110 06:51], Steve Brown ([EMAIL PROTECTED]) 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 docstri
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:
>
> > #
> > #
> > # Temperature Sense Test
> > #
> > #
> > class Test3(ar_test.AR_TEST):
> > """Temperature Sense Test"""
>
> > I don'
Steve Brown wrote:
> 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
> th
On Jan 9, 9:47 pm, "Steve Brown" <[EMAIL PROTECTED]> wrote:
> 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 t
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
12 matches
Mail list logo
