Home Original page

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

Stephen J. Turnbull stephen at xemacs.org
Fri Jun 28 11:14:41 CEST 2013 
Terry Reedy writes:

 > Ok, I won't add them when a function's name actually makes what it does 
 > obvious. But when I have to spend at least a few minutes reading the 
 > body to make sense of it, I will try to add the summary line that I wish 
 > had been there already.

+1  That's a *great* rule-of-thumb!
More information about the Python-Dev mailing list