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: Docstring for asyncio.protocols.BufferedProtocol appears out of date
Type: behavior Stage: resolved
Components: asyncio, Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: AlexWaygood, asvetlov, docs@python, miss-islington, yselivanov
Priority: normal Keywords: patch

Created on 2022-02-13 21:13 by AlexWaygood, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 31327 merged AlexWaygood, 2022-02-14 14:56
PR 31361 merged miss-islington, 2022-02-15 16:39
PR 31362 merged miss-islington, 2022-02-15 16:41
Messages (6)
msg413196 - (view) Author: Alex Waygood (AlexWaygood) * (Python triager) Date: 2022-02-13 21:13
The docstring for asyncio.protocols.BufferedProtocol includes this paragraph:

"""
Important: this has been added to asyncio in Python 3.7
*on a provisional basis*!  Consider it as an experimental API that
might be changed or removed in Python 3.8.
"""

The main branch is now 3.11, and the class has not yet been removed, so I'm guessing it's now safe to say that it's here to stay?
msg413218 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-14 10:40
Alex, you are right. BufferedProtocol is considered stable since 3.8
A pull request with docstring fix is welcome.
msg413227 - (view) Author: Alex Waygood (AlexWaygood) * (Python triager) Date: 2022-02-14 14:57
Thanks, Andrew! I've submitted a patch.
msg413295 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-15 16:39
New changeset 1d81fdc4c004511c25f74db0e04ddbbb8a04ce6d by Alex Waygood in branch 'main':
bpo-46741: Update `asyncio.protocols.BufferedProtocol` docstring (31327)
https://github.com/python/cpython/commit/1d81fdc4c004511c25f74db0e04ddbbb8a04ce6d
msg413296 - (view) Author: miss-islington (miss-islington) Date: 2022-02-15 17:08
New changeset c292118ef3528df85a9d76ad21029009b560b088 by Miss Islington (bot) in branch '3.9':
bpo-46741: Update `asyncio.protocols.BufferedProtocol` docstring (31327)
https://github.com/python/cpython/commit/c292118ef3528df85a9d76ad21029009b560b088
msg413297 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-02-15 17:14
New changeset 72c46462aa9fd0a69317917ba127e62f94ce08d7 by Miss Islington (bot) in branch '3.10':
bpo-46741: Update `asyncio.protocols.BufferedProtocol` docstring (GH-31327) (GH-31362)
https://github.com/python/cpython/commit/72c46462aa9fd0a69317917ba127e62f94ce08d7
History
Date User Action Args
2022-04-11 14:59:56adminsetgithub: 90897
2022-02-15 17:14:30asvetlovsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2022-02-15 17:14:17asvetlovsetmessages: + msg413297
2022-02-15 17:08:40miss-islingtonsetmessages: + msg413296
2022-02-15 16:41:26miss-islingtonsetpull_requests: + pull_request29512
2022-02-15 16:39:59asvetlovsetmessages: + msg413295
2022-02-15 16:39:40miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request29511
2022-02-14 14:57:41AlexWaygoodsetmessages: + msg413227
2022-02-14 14:56:24AlexWaygoodsetkeywords: + patch
stage: patch review
pull_requests: + pull_request29483
2022-02-14 10:40:14asvetlovsetmessages: + msg413218
2022-02-13 21:13:07AlexWaygoodcreate