By the way, https://docs.python.org/dev/whatsnew/3.10.html#improved-modules
is inconsistent:

"asyncio: Added missing ..."

versus

"base64: Add base64.b32hexencode() ..."

You can also find such inconsistencies in "versionchanged" markups.

Victor

On Fri, Apr 30, 2021 at 5:01 AM Larry Hastings <la...@hastings.org> wrote:
>
>
> When one writes one's "blurb" for the changelog, in what tense should it be?  
> I mostly see entries in present tense:
>
> bpo-43660: Fix crash that happens when replacing sys.stderr with a callable 
> that can remove the object while an exception is being printed. Patch by 
> Pablo Galindo.
>
> bpo-41561: Add workaround for Ubuntu’s custom OpenSSL security level policy.
>
> But occasionally I see entries in past tense:
>
> bpo-26053: Fixed bug where the pdb interactive run command echoed the args 
> from the shell command line, even if those have been overridden at the pdb 
> prompt.
>
> bpo-40630: Added tracemalloc.reset_peak() to set the peak size of traced 
> memory blocks to the current size, to measure the peak of specific pieces of 
> code.
>
> I couldn't find any guidance in the Python Dev Guide after sixty seconds of 
> poking around.
>
>
> Obviously this isn't a big deal.  But it might be nice to try and nudge 
> everybody in the same direction.  It'd be pleasant if the changelog read in a 
> more unified voice, and using the same tense and sentence structure would 
> help towards that goal.
>
> If we arrived at a firm decision, maybe "blurb" et al could add a little text 
> suggesting the proper style.
>
>
> Cheers,
>
>
> /arry
>
> _______________________________________________
> 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/SUEPLPRN2IY7EGC7XBLWWN2BOLM3GYMQ/
> Code of Conduct: http://python.org/psf/codeofconduct/



-- 
Night gathers, and now my watch begins. It shall not end until my death.
_______________________________________________
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/BG7AI3YKZ6S2NR5556ZJ6XY6N5NHZWFL/
Code of Conduct: http://python.org/psf/codeofconduct/

Reply via email to