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 slateny
Recipients belopolsky, docs@python, fdrake, p-ganssle, slateny
Date 2022-04-05.07:58:04
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1649145484.32.0.775961793852.issue47207@roundup.psfhosted.org>
In-reply-to
Content
Is there a bpo page or some sort that discusses why the imperative mood is used over the indicative mood other than convention of PEP 257? I found this (https://mail.python.org/pipermail/tutor/2012-May/089584.html) question and answer that seems to make sense, but it's not quite an official source.

If the reason for using imperative mood in docstrings doesn't apply to documentation, then I think there wouldn't be any problems in changing it. One thing raised in the mail thread was that 'Returns ...' isn't strictly grammatical, so perhaps that's something to consider.
History
Date User Action Args
2022-04-05 07:58:04slatenysetrecipients: + slateny, fdrake, belopolsky, docs@python, p-ganssle
2022-04-05 07:58:04slatenysetmessageid: <1649145484.32.0.775961793852.issue47207@roundup.psfhosted.org>
2022-04-05 07:58:04slatenylinkissue47207 messages
2022-04-05 07:58:04slatenycreate