[New-bugs-announce] [issue46777] Fix incorrect use of directives in asyncio documentation

Serhiy Storchaka report at bugs.python.org
Thu Feb 17 07:54:16 EST 2022

New submission from Serhiy Storchaka <storchaka+cpython at gmail.com>:

There are some issues with formatting added or removed parameters in the asyncio module.

1. "deprecated-removed" directives were used for already removed directives. It should be used for deprecated features with known term of removal. For removed features "versionchanged" is more appropriate.

2. Text for removed parameters was too verbose. "Removed the XXX parameter" would be enough.

3. "versionadded" directives were used for new parameters. "versionchanged" directive is more appropriate. It is a date of the change in existing function, not the date of adding the function itself.

4. Some directives were written not in order of increasing version number.

5. In some places parameters were marked up as ``name``. *name* is commonly used for parameters.

assignee: docs at python
components: Documentation, asyncio
messages: 413404
nosy: asvetlov, docs at python, kj, serhiy.storchaka, yselivanov
priority: normal
severity: normal
status: open
title: Fix incorrect use of directives in asyncio documentation
type: enhancement
versions: Python 3.10, Python 3.11

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list