Skip to content

Inline comments about Task state in asyncio.tasks are out of date #109955

New issue
New issue
Closed
Closed
Inline comments about Task state in asyncio.tasks are out of date#109955
Labels
3.12only security fixes3.13only security fixesdocsDocumentation in the Doc dirtopic-asynciotype-bugAn unexpected behavior, bug, or error

Description

@kristjanvalur
kristjanvalur
opened on Sep 27, 2023

Documentation

Some of the in-line comments in the asyncio.tasks module are out of date. They incorrectly describe the state transitions between a task in a sleeping and running state. This is unhelpful to anyone reading the code.
I've created a PR in #109910 where I offer an expanded comment reflecting the current logic.

Linked PRs

Activity

  1. kristjanvalur
    added
    docsDocumentation in the Doc dir
    on Sep 27, 2023
  2. AA-Turner
    changed the title [-]In line comments about Task state in tasks.py out of date[/-] [+]Inline comments about Task state in ``asyncio.tasks`` are out of date[/+] on Sep 27, 2023
  3. AA-Turner
    added
    type-bugAn unexpected behavior, bug, or error
    topic-asyncio
    3.11only security fixes
    3.12only security fixes
    3.13only security fixes
    on Sep 27, 2023
  4. github-project-automation
    added this to asyncioon Sep 27, 2023
  5. github-project-automation
    moved this to Todo in asyncioon Sep 27, 2023
  6. AA-Turner
    removed
    3.11only security fixes
    on Sep 27, 2023
  7. gvanrossum
    added a commit that references this issue on Sep 27, 2023

    gh-109955 : Update state transition comments for asyncio.Task (#109910)

    45cf5b0
  8. miss-islington
    added 2 commits that reference this issue on Sep 27, 2023

    pythongh-109955 : Update state transition comments for asyncio.Task (p…

    9669321

    pythongh-109955 : Update state transition comments for asyncio.Task (p…

    f04c4d5
  9. gvanrossum
    closed this as completedon Sep 27, 2023
  10. github-project-automation
    moved this from Todo to Done in asyncioon Sep 27, 2023
  11. csm10495
    added a commit that references this issue on Sep 28, 2023

    pythongh-109955 : Update state transition comments for asyncio.Task (p…

    bd9e1cb
  12. vstinner
    added a commit that references this issue on Sep 29, 2023

    [3.11] gh-109955 : Update state transition comments for asyncio.Task (G…

    4b97c72
  13. Yhg1s
    added a commit that references this issue on Oct 2, 2023

    [3.12] gh-109955 : Update state transition comments for asyncio.Task (G…

    dd67e59
  14. Glyphack
    added a commit that references this issue on Sep 2, 2024

    pythongh-109955 : Update state transition comments for asyncio.Task (p…

    729adb0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    3.12only security fixes3.13only security fixesdocsDocumentation in the Doc dirtopic-asynciotype-bugAn unexpected behavior, bug, or error

    Projects

    • asyncio
      Status
      Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions