[issue38652] Remove/update provisional note for asyncio.BufferedProtocol
New submission from Kyle Stanley <aeros167@gmail.com>: In the documentation (https://docs.python.org/3.9/library/asyncio-protocol.html#buffered-streaming...) 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.
---------- assignee: docs@python components: Documentation messages: 355739 nosy: aeros, asvetlov, docs@python, yselivanov priority: normal severity: normal status: open title: Remove/update provisional note for asyncio.BufferedProtocol versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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. ---------- keywords: +newcomer friendly _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Kyle Stanley <aeros167@gmail.com>: ---------- components: +asyncio _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Benjamin Edwards <benjaminedwards@live.co.uk> added the comment: Hey Kyle, I'm a newcomer, would it be ok for me to take on this propsal? Ben ---------- nosy: +benedwards14 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Yury Selivanov <yselivanov@gmail.com> added the comment: Yeah, please do the change! Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Anj-A <2017anj@gmail.com> added the comment: Hey, I've done the change and opened a pull request for it (I'm working with Ben and I've let him know) ---------- nosy: +Anj-A _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Anj-A <2017anj@gmail.com>: ---------- keywords: +patch pull_requests: +16563 stage: -> patch review pull_request: https://github.com/python/cpython/pull/17047 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: 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/4443450fdaf248427cf4a00a6ee36229e64... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Andrew Svetlov <andrew.svetlov@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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. ---------- keywords: +newcomer friendly _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Kyle Stanley <aeros167@gmail.com>: ---------- components: +asyncio _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Benjamin Edwards <benjaminedwards@live.co.uk> added the comment: Hey Kyle, I'm a newcomer, would it be ok for me to take on this propsal? Ben ---------- nosy: +benedwards14 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Yury Selivanov <yselivanov@gmail.com> added the comment: Yeah, please do the change! Thanks! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Anj-A <2017anj@gmail.com> added the comment: Hey, I've done the change and opened a pull request for it (I'm working with Ben and I've let him know) ---------- nosy: +Anj-A _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Kyle Stanley <aeros167@gmail.com> added the comment:
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 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Anj-A <2017anj@gmail.com>: ---------- keywords: +patch pull_requests: +16563 stage: -> patch review pull_request: https://github.com/python/cpython/pull/17047 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: 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/4443450fdaf248427cf4a00a6ee36229e64... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
Change by Andrew Svetlov <andrew.svetlov@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue38652> _______________________________________
participants (6)
-
Andrew Svetlov -
Anj-A
-
Benjamin Edwards
-
Kyle Stanley
-
miss-islington
-
Yury Selivanov