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: Remove/update provisional note for asyncio.BufferedProtocol
Type: Stage: resolved
Components: asyncio, Documentation Versions: Python 3.9, Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Anj-A, aeros, asvetlov, benedwards14, docs@python, miss-islington, yselivanov
Priority: normal Keywords: newcomer friendly, patch

Created on 2019-10-31 06:14 by aeros, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 17047 merged Anj-A, 2019-11-04 19:16
Messages (8)
msg355739 - (view) Author: Kyle Stanley (aeros) * (Python committer) Date: 2019-10-31 06:14
In the documentation (https://docs.python.org/3.9/library/asyncio-protocol.html#buffered-streaming-protocols) for asyncio.BufferedProtocol there is a provisional API note. This should be updated/removed for 3.8 and 3.9 since it became a part of the stable API in 3.8.

Current:

> New in version 3.7: Important: this has been added to asyncio in Python 3.7 on a provisional basis! This is as an experimental API that might be changed or removed completely in Python 3.8.

I would propose to changing it to:

> New in version 3.7.
msg355740 - (view) Author: Kyle Stanley (aeros) * (Python committer) Date: 2019-10-31 06:20
> I would propose to changing it to:

propose changing it to*

Also, I think this issue would be a good candidate for "newcomer friendly", since it's a simple and well-defined documentation update. It could provide a decent introduction for contributing to CPython.
msg355746 - (view) Author: Benjamin Edwards (benedwards14) * Date: 2019-10-31 11:55
Hey Kyle,

I'm a newcomer, would it be ok for me to take on this propsal?

Ben
msg355768 - (view) Author: Kyle Stanley (aeros) * (Python committer) Date: 2019-10-31 21:24
> I'm a newcomer, would it be ok for me to take on this propsal?

It will need approval from Yury and/or Andrew before it can be merged, but I think this is relatively uncontroversial. You can definitely work on it though.
msg355770 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2019-10-31 21:42
Yeah, please do the change! Thanks!
msg355967 - (view) Author: (Anj-A) * Date: 2019-11-04 18:05
Hey, I've done the change and opened a pull request for it (I'm working with Ben and I've let him know)
msg355976 - (view) Author: Kyle Stanley (aeros) * (Python committer) Date: 2019-11-04 19:01
> Hey, I've done the change and opened a pull request for it (I'm working with Ben and I've let him know)

Make sure to change the title of the PR to "bpo-<issue_number>: <pr_title>", this will automatically attach the PR to the associated bpo issue. For example, if your PR title was "Remove provisional note for asyncio.BufferedProtocol", the full title should be:

bpo-38652: Remove provisional note for asyncio.BufferedProtocol
msg357974 - (view) Author: miss-islington (miss-islington) Date: 2019-12-07 12:53
New changeset 4443450fdaf248427cf4a00a6ee36229e6402ec6 by Miss Islington (bot) (Anj-A) in branch 'master':
bpo-38652: Remove provisional note for asyncio.BufferedProtocol (GH-17047)
https://github.com/python/cpython/commit/4443450fdaf248427cf4a00a6ee36229e6402ec6
History
Date User Action Args
2022-04-11 14:59:22adminsetgithub: 82833
2019-12-07 12:54:05asvetlovsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2019-12-07 12:53:16miss-islingtonsetnosy: + miss-islington
messages: + msg357974
2019-11-04 19:16:09Anj-Asetkeywords: + patch
stage: patch review
pull_requests: + pull_request16563
2019-11-04 19:01:54aerossetmessages: + msg355976
2019-11-04 18:05:31Anj-Asetnosy: + Anj-A
messages: + msg355967
2019-10-31 21:42:58yselivanovsetmessages: + msg355770
2019-10-31 21:24:08aerossetmessages: + msg355768
2019-10-31 11:55:13benedwards14setnosy: + benedwards14
messages: + msg355746
2019-10-31 06:22:02aerossetcomponents: + asyncio
2019-10-31 06:20:16aerossetkeywords: + newcomer friendly

messages: + msg355740
2019-10-31 06:14:41aeroscreate