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

Jean-Paul Calderone exarkun at divmod.com
Mon Jul 24 22:40:44 EDT 2006


On Mon, 24 Jul 2006 22:03:12 -0400, Stephen Waterbury <golux at comcast.net> wrote:
>Jonathan Lange wrote:
>>The standard is definitely unclear.
>>
>>I don't have strong feelings about how docstrings should be formatted.
>>However I would prefer it if we used PEP 257 formatting.
>
>Just for the record, the multi-line docstring format
>
>"""
>Blah blah blah blah blah
>blah.
>"""
>
>is consistent with PEP 257's recommendations.
>>Also, I strongly object to using
>>"""
>>Blah.
>>"""
>>for one line docstrings.
>
>It doesn't bother me, but
>
>"""Blah."""
>
>doesn't either, for one-liners.
>

This one doesn't really bother me either, although I very slightly prefer
the long form.

This bothers me a lot, though:

""" Blah. """

Jean-Paul




More information about the Twisted-Python mailing list