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: typing.Coroutine documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Elaphurus, docs@python, gvanrossum, lukasz.langa, xtreak
Priority: normal Keywords: easy, newcomer friendly, patch

Created on 2020-08-24 12:33 by Elaphurus, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 21952 merged Elaphurus, 2020-08-25 06:25
PR 21982 merged xtreak, 2020-08-27 11:37
PR 21983 merged xtreak, 2020-08-27 11:43
Messages (5)
msg375841 - (view) Author: MingZhe Hu (Elaphurus) * Date: 2020-08-24 12:33
The documentation [1] for Coroutine in typing library writes:

class typing.Coroutine(Awaitable[V_co], Generic[T_co T_contra, V_co])

which should be:

class typing.Coroutine(Awaitable[V_co], Generic[T_co, T_contra, V_co])

a comma is missed between the first type variable T_co and the second one T_contr.

[1] https://docs.python.org/3/library/typing.html#typing.Generic
msg375846 - (view) Author: Karthikeyan Singaravelan (xtreak) * (Python committer) Date: 2020-08-24 14:27
Thanks for the report. This seems to be a reasonable suggestion. Would you like to open a PR for this?
msg375970 - (view) Author: Łukasz Langa (lukasz.langa) * (Python committer) Date: 2020-08-27 00:43
New changeset 8c58d2a216ca2b5965361df9b8d8944bc7d4854d by MingZhe Hu in branch 'master':
bpo-41624: fix documentation of typing.Coroutine (GH-21952)
https://github.com/python/cpython/commit/8c58d2a216ca2b5965361df9b8d8944bc7d4854d
msg376041 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2020-08-28 15:04
New changeset 838316db08a8e3174e4cf8db233ff69d388b3f5c by Karthikeyan Singaravelan in branch '3.8':
[3.8] bpo-41624: fix documentation of typing.Coroutine (GH-21952). (#21983)
https://github.com/python/cpython/commit/838316db08a8e3174e4cf8db233ff69d388b3f5c
msg376042 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2020-08-28 15:06
New changeset c01a7edc67e2c2e13a6d9513f111f27761786e27 by Karthikeyan Singaravelan in branch '3.9':
[3.9] bpo-41624: fix documentation of typing.Coroutine (GH-21952) (#21982)
https://github.com/python/cpython/commit/c01a7edc67e2c2e13a6d9513f111f27761786e27
History
Date User Action Args
2022-04-11 14:59:35adminsetgithub: 85790
2020-08-28 15:07:08gvanrossumsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2020-08-28 15:06:42gvanrossumsetmessages: + msg376042
2020-08-28 15:04:11gvanrossumsetnosy: + gvanrossum
messages: + msg376041
2020-08-27 11:43:41xtreaksetpull_requests: + pull_request21092
2020-08-27 11:37:48xtreaksetpull_requests: + pull_request21091
2020-08-27 00:43:10lukasz.langasetnosy: + lukasz.langa
messages: + msg375970
2020-08-25 06:25:18Elaphurussetkeywords: + patch
stage: patch review
pull_requests: + pull_request21061
2020-08-24 14:27:26xtreaksetkeywords: + easy, newcomer friendly
nosy: + xtreak
messages: + msg375846

2020-08-24 12:33:44Elaphuruscreate