New submission from Serhiy Storchaka <storchaka+cpyt...@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@python components: Documentation, asyncio messages: 413404 nosy: asvetlov, docs@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 <rep...@bugs.python.org> <https://bugs.python.org/issue46777> _______________________________________ _______________________________________________ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
