Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typing.Coroutine documentation #85790

Closed
Elaphurus mannequin opened this issue Aug 24, 2020 · 5 comments
Closed

typing.Coroutine documentation #85790

Elaphurus mannequin opened this issue Aug 24, 2020 · 5 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir easy

Comments

@Elaphurus
Copy link
Mannequin

Elaphurus mannequin commented Aug 24, 2020

BPO 41624
Nosy @gvanrossum, @ambv, @tirkarthi, @Elaphurus
PRs
  • bpo-41624: fix documentation of typing.Coroutine #21952
  • [3.9] bpo-41624: fix documentation of typing.Coroutine (GH-21952) #21982
  • [3.8] bpo-41624: fix documentation of typing.Coroutine (GH-21952). #21983
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
    closed_at = <Date 2020-08-28.15:07:08.549>
    created_at = <Date 2020-08-24.12:33:44.232>
    labels = ['easy', '3.7', '3.8', 'docs']
    title = 'typing.Coroutine documentation'
    updated_at = <Date 2020-08-28.15:07:08.548>
    user = 'https://github.com/Elaphurus'

    bugs.python.org fields:

    activity = <Date 2020-08-28.15:07:08.548>
    actor = 'gvanrossum'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2020-08-28.15:07:08.549>
    closer = 'gvanrossum'
    components = ['Documentation']
    creation = <Date 2020-08-24.12:33:44.232>
    creator = 'Elaphurus'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41624
    keywords = ['patch', 'easy', 'newcomer friendly']
    message_count = 5.0
    messages = ['375841', '375846', '375970', '376041', '376042']
    nosy_count = 5.0
    nosy_names = ['gvanrossum', 'docs@python', 'lukasz.langa', 'xtreak', 'Elaphurus']
    pr_nums = ['21952', '21982', '21983']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue41624'
    versions = ['Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8']

    @Elaphurus
    Copy link
    Mannequin Author

    Elaphurus mannequin commented Aug 24, 2020

    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

    @Elaphurus Elaphurus mannequin added 3.7 (EOL) end of life 3.8 only security fixes labels Aug 24, 2020
    @Elaphurus Elaphurus mannequin assigned docspython Aug 24, 2020
    @Elaphurus Elaphurus mannequin added docs Documentation in the Doc dir 3.7 (EOL) end of life 3.8 only security fixes labels Aug 24, 2020
    @Elaphurus Elaphurus mannequin assigned docspython Aug 24, 2020
    @Elaphurus Elaphurus mannequin added the docs Documentation in the Doc dir label Aug 24, 2020
    @tirkarthi
    Copy link
    Member

    Thanks for the report. This seems to be a reasonable suggestion. Would you like to open a PR for this?

    @ambv
    Copy link
    Contributor

    ambv commented Aug 27, 2020

    New changeset 8c58d2a by MingZhe Hu in branch 'master':
    bpo-41624: fix documentation of typing.Coroutine (GH-21952)
    8c58d2a

    @gvanrossum
    Copy link
    Member

    New changeset 838316d by Karthikeyan Singaravelan in branch '3.8':
    [3.8] bpo-41624: fix documentation of typing.Coroutine (GH-21952). (bpo-21983)
    838316d

    @gvanrossum
    Copy link
    Member

    New changeset c01a7ed by Karthikeyan Singaravelan in branch '3.9':
    [3.9] bpo-41624: fix documentation of typing.Coroutine (GH-21952) (bpo-21982)
    c01a7ed

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir easy
    Projects
    None yet
    Development

    No branches or pull requests

    3 participants