[Python-Dev] Re: In what tense should the changelog be written?

2021-05-01 Thread Jeff Allen

On 30/04/2021 13:15, Steven D'Aprano wrote:

On Thu, Apr 29, 2021 at 09:52:14PM -0700, Larry Hastings wrote:

D'oh!  I have a second draft already.

Your NEWS entry should be written in the /present tense,/ and should
start with a verb:

Without a subject of the sentence, that's not present tense, it is the
imperative mood.
Tense and mood are different dimensions. This is the present tense, and 
the imperative mood:

 "Fix buffalo.spam ..."

is a command or suggestion. The imperative is suitable for a list of
things which should be done, a TODO list, not a list of things which
have already been done.

https://grammar.collinsdictionary.com/easy-learning/the-imperative


The reference is not very good at explaining this, perhaps because the 
mood in English is not obvious. (Sometimes you have to be French.)


The instruction "in the present tense, and should start with a verb" 
doesn't pin it down, at least if you consider context and are liberal 
about punctuation:


# present tense, indicative mood
"bpo-41056: Fixes a reference to deallocated stack ..." -> "bpo-41056 fixes 
...

# present tense, imperative mood
"bpo-41094: Fix decoding errors with audit ... "

The preference for the imperative mood probably begins with the title of 
a change *request*, where the imperative is the one obvious choice, 
don't you think? I think I prefer it, but if blurb does not mine the 
commit/PR for text, it's not a constraint. If the trail starts with a 
bug report ("buffalo.spam borks the weeble when x is negative" (present 
indicative)) then that makes a confusing commit or news message as Guido 
points out.


Jeff

___
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/KZPKYFWTFOFL5EXRLY7KOEDO576AXF7A/
Code of Conduct: http://python.org/psf/codeofconduct/


[Python-Dev] Re: Announcing the CPython Docs Workgroup

2021-05-01 Thread Raymond Hettinger
Please add me to the list of members for the initial workgroup.

Thank you,


Raymond
___
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/DQXRKNTL2XJFRQXS4W777XB6XUOVSINL/
Code of Conduct: http://python.org/psf/codeofconduct/


[Python-Dev] Re: Announcing the CPython Docs Workgroup

2021-05-01 Thread Carol Willing
Hi Raymond,

In about a month after the Language Summit, we'll have an open call for
applications for the Docs Workgroup similar to how the PSF gets and reviews
applications for the Code of Conduct workgroup.

Please keep an eye out for an announcement on Discourse, Python-Dev, and
the docs-community repo for more information. I already have you on an
interest list from last year.

Thanks,

Carol

On Sat, May 1, 2021 at 4:36 PM Raymond Hettinger <
raymond.hettin...@gmail.com> wrote:

> Please add me to the list of members for the initial workgroup.
>
> Thank you,
>
>
> Raymond
> ___
> 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/DQXRKNTL2XJFRQXS4W777XB6XUOVSINL/
> 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/XW76K37AU3CP4XKCRO7YSJAYBMUYHNWB/
Code of Conduct: http://python.org/psf/codeofconduct/