Docstrings considered too complicated

John Bokma john at castleamber.com
Sat Feb 27 01:47:26 CET 2010


Steven D'Aprano <steve at REMOVE-THIS-cybersource.com.au> writes:

> On Fri, 26 Feb 2010 09:09:36 -0600, Tim Daneliuk wrote:
>
>> Reminiscent of:
>> 
>> mov  AX,BX               ; Move the contents of BX into AX
>
>
> That's a *good* comment, because without it most English-speaking people 
> would assume you were moving the contents of AX into BX.

Eh? It's a bad comment, it's of the same quality as:

> x = x + 1  # Add one to x.

You think the former is good because (I guess) you are not familiar with
the language. The same reason why beginners comment their code like in
your example.

-- 
John Bokma                                                               j3b

Hacking & Hiking in Mexico -  http://johnbokma.com/
http://castleamber.com/ - Perl & Python Development



More information about the Python-list mailing list