This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author terry.reedy
Recipients docs@python, marco.buttu, terry.reedy, tshepang
Date 2013-09-28.20:17:15
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <>
PEP8 just says "PEP 257 describes good docstring conventions."
PEP 257 is what says '''It [the one line docstring] prescribes the function or method's effect as a command ("Do this", "Return that"), not as a description; e.g. don't write "Returns the pathname ...". '''

I strongly prefer the rule, but we do not usually patch purely for PEP8 compliance. However, a docstring patch is safer than a code patch.
Date User Action Args
2013-09-28 20:17:15terry.reedysetrecipients: + terry.reedy, docs@python, tshepang, marco.buttu
2013-09-28 20:17:15terry.reedysetmessageid: <>
2013-09-28 20:17:15terry.reedylinkissue19067 messages
2013-09-28 20:17:15terry.reedycreate