I'll wait to see if anybody else has contrary opinions, but for now
here's a first draft:
Your NEWS entry should be written in the present tense, and should
start with a verb:
* Added foo [...]
* Changed bar [...]
* Removed bat [...]
* Fixed buffalo.spam [...]
Function and class names should not be followed by parentheses,
unless demonstrating an example call.
//arry/
On 4/29/21 9:15 PM, Guido van Rossum wrote:
There’s something in the dev guide, but not about tense. Worth adding.
(My pet peeve is not to write “The foo module resets the bar state
when spam happens,” because that isn’t clear about whether that’s the
before or after behavior.)
On Thu, Apr 29, 2021 at 17:37 Ethan Furman <et...@stoneleaf.us
<mailto:et...@stoneleaf.us>> wrote:
On 4/29/21 7:57 PM, Larry Hastings wrote:
> When one writes one's "blurb" for the changelog, in what tense
should it be?
Present tense. :)
--
~Ethan~
_______________________________________________
Python-Dev mailing list -- python-dev@python.org
<mailto:python-dev@python.org>
To unsubscribe send an email to python-dev-le...@python.org
<mailto:python-dev-le...@python.org>
https://mail.python.org/mailman3/lists/python-dev.python.org/
<https://mail.python.org/mailman3/lists/python-dev.python.org/>
Message archived at
https://mail.python.org/archives/list/python-dev@python.org/message/AM3TQUXVNKGOAEC2GBVNUZAZOCLAD6N3/
<https://mail.python.org/archives/list/python-dev@python.org/message/AM3TQUXVNKGOAEC2GBVNUZAZOCLAD6N3/>
Code of Conduct: http://python.org/psf/codeofconduct/
<http://python.org/psf/codeofconduct/>
--
--Guido (mobile)
_______________________________________________
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at
https://mail.python.org/archives/list/python-dev@python.org/message/FNV3QHWZCNAHPNLR3SPTOGUFEYHJSYEK/
Code of Conduct: http://python.org/psf/codeofconduct/
_______________________________________________
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at
https://mail.python.org/archives/list/python-dev@python.org/message/DOL55BKC7FNLZCDPKRXLW6PT5EADZXQ3/
Code of Conduct: http://python.org/psf/codeofconduct/
