This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Fix incorrect use of directives in asyncio documentation
Type: enhancement Stage: resolved
Components: asyncio, Documentation Versions: Python 3.11, Python 3.10
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: asvetlov, docs@python, gvanrossum, kj, miss-islington, serhiy.storchaka, yselivanov
Priority: normal Keywords: patch

Created on 2022-02-17 12:54 by serhiy.storchaka, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 31388 merged serhiy.storchaka, 2022-02-17 13:13
PR 31403 merged miss-islington, 2022-02-18 08:59
Messages (5)
msg413404 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2022-02-17 12:54
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.
msg413408 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2022-02-17 13:29
6. The loop parameter of Task() was documented as both removed and required (if there is no current event loop) in 3.10.
msg413469 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2022-02-18 08:59
New changeset 2923d87ca258b9d421e8147b12f0d98295ee3f8e by Serhiy Storchaka in branch 'main':
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
https://github.com/python/cpython/commit/2923d87ca258b9d421e8147b12f0d98295ee3f8e
msg413470 - (view) Author: miss-islington (miss-islington) Date: 2022-02-18 09:30
New changeset 6eb34772fda2e46ba9a265e038b6e0f303bd790e by Miss Islington (bot) in branch '3.10':
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388)
https://github.com/python/cpython/commit/6eb34772fda2e46ba9a265e038b6e0f303bd790e
msg413474 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-18 10:40
> 6. The loop parameter of Task() was documented as both removed and required (if there is no current event loop) in 3.10.

I think we should drop Task() constructor definition from Task Object docs https://docs.python.org/3/library/asyncio-task.html#task-object but create 'asyncio-extending.rst' (suggest better name please) with low-level task documentation for guys who want to create their own task class.

Task constructor could be documented here along with `_register_task()`, `_enter_task()`, `_leave_task()`, `_unregister_task()`. They might be useful for ones who implements a custom task factories.
History
Date User Action Args
2022-04-11 14:59:56adminsetgithub: 90933
2022-03-07 10:30:22serhiy.storchakalinkissue46341 superseder
2022-02-26 16:13:00gvanrossumsetnosy: + gvanrossum
2022-02-26 16:12:51gvanrossumlinkissue46661 superseder
2022-02-19 08:09:43serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2022-02-18 10:40:45asvetlovsetmessages: + msg413474
2022-02-18 09:30:53miss-islingtonsetmessages: + msg413470
2022-02-18 08:59:19serhiy.storchakasetmessages: + msg413469
2022-02-18 08:59:02miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request29543
2022-02-17 13:29:04serhiy.storchakasetmessages: + msg413408
2022-02-17 13:13:46serhiy.storchakasetkeywords: + patch
stage: patch review
pull_requests: + pull_request29533
2022-02-17 12:54:16serhiy.storchakacreate