Home Original page

[Python-Dev] Reminder: an oft-forgotten rule about docstring formatting (PEP 257)

Ethan Furman ethan at stoneleaf.us
Thu Jun 27 04:14:01 CEST 2013 
On 06/26/2013 07:08 PM, Skip Montanaro wrote:
>> I'd like to urge stdlib contributors and core devs to
>> heed it -- or explain why you can't.
>
> Where I can, I do, however I often find it difficult to come up with a
> one-liner, especially one that mentions the parameters to functions.
> If the one-line rule is going to be violated, I go whole hog and don't
> bother with the blank line either.  (If I'm going to punch a hole in a
> rule, I might as well create one big enough to comfortably walk
> through.)

Why do the parameters have to be in the summary?  You could do them better justice in the following paragraphs.

--
~Ethan~
More information about the Python-Dev mailing list