[Twisted-Python] Re: [Twisted-commits] r17664 - This was pre-UQDS code, so in making the transition I have to add lots of docs

James Y Knight foom at fuhm.net
Mon Jul 24 12:12:35 EDT 2006


On Jul 24, 2006, at 9:59 AM, Jean-Paul Calderone wrote:
>> class Argument:
>> +    """ Base-class of all objects that take values from Amp  
>> packets and convert
>> +    them into objects for Python functions.
>> +    """
>
> Blech.  Does this style of docstring formatting make anyone else barf?

No, I can't say it does. However, it does make me usually miss the  
first line the first time through and then have to back up and read  
it again. So in that respect, it's non-optimal.

James






More information about the Twisted-Python mailing list