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

Ben Finney ben+python at benfinney.id.au
Fri Jun 28 03:25:00 CEST 2013

Antoine Pitrou <solipsis at pitrou.net> writes:

> I don't always find it easy to summarize a function in one line.

Difficulty in coming up with an accurate one-line summary of the intent
of a function is a code smell: the function probably needs to be
simplified so it is easier to describe accurately.

This is, IMO, one of the primary benefits of having a convention of
expecting a one-line summary for every function (and module and class).

 \          “Courage is not the absence of fear, but the decision that |
  `\     something else is more important than fear.” —Ambrose Redmoon |
_o__)                                                                  |
Ben Finney

More information about the Python-Dev mailing list