Skip to content

sys.set_asyncgen_hooks docs are not correct about its signature #114384

Closed
Closed
sys.set_asyncgen_hooks docs are not correct about its signature#114384
Assignees
sobolevn
Labels
docsDocumentation in the Doc dirinterpreter-core(Objects, Python, Grammar, and Parser dirs)type-bugAn unexpected behavior, bug, or error

Description

@sobolevn
sobolevn
opened on Jan 21, 2024

Bug report

Refs #103132 (comment)

The signature is set_asyncgen_hooks(firstiter=<unrepresentable>, finalizer=<unrepresentable>).
Docs say that it is: set_asyncgen_hooks(firstiter, finalizer)
Docstring say that it is: set_asyncgen_hooks(* [, firstiter] [, finalizer])

It should be: set_asyncgen_hooks([firstiter] [, finalizer]) (I guess)

Linked PRs

Activity

  1. sobolevn
    added
    type-bugAn unexpected behavior, bug, or error
    docsDocumentation in the Doc dir
    interpreter-core(Objects, Python, Grammar, and Parser dirs)
    pendingThe issue will be closed if no feedback is provided
    on Jan 21, 2024
  2. sobolevn
    self-assigned this
    on Jan 21, 2024
  3. sobolevn
    removed
    pendingThe issue will be closed if no feedback is provided
    on Jan 21, 2024
  4. sobolevn
    added a commit that references this issue on Jan 21, 2024

    pythongh-114384: Fix `sys.set_asyncgen_hooks` signature in docs

    2d18ad9
  5. erlend-aasland
    added a commit that references this issue on Jan 21, 2024

    gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect …

    38768e4
  6. miss-islington
    added 2 commits that reference this issue on Jan 21, 2024

    pythongh-114384: Align sys.set_asyncgen_hooks signature in docs to re…

    c8dcd84

    pythongh-114384: Align sys.set_asyncgen_hooks signature in docs to re…

    718bf8b
  7. erlend-aasland
    added 2 commits that reference this issue on Jan 21, 2024

    [3.11] gh-114384: Align sys.set_asyncgen_hooks signature in docs to r…

    d2cfb5b

    [3.12] gh-114384: Align sys.set_asyncgen_hooks signature in docs to r…

    afefa4a
  8. AA-Turner
    closed this as completedon Jan 21, 2024
  9. kulikjak
    added a commit that references this issue on Jan 22, 2024

    pythongh-114384: Align sys.set_asyncgen_hooks signature in docs to re…

    80ae3e8
  10. aisk
    added a commit that references this issue on Feb 11, 2024

    pythongh-114384: Align sys.set_asyncgen_hooks signature in docs to re…

    63ee1de
  11. Glyphack
    added a commit that references this issue on Sep 2, 2024

    pythongh-114384: Align sys.set_asyncgen_hooks signature in docs to re…

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

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirinterpreter-core(Objects, Python, Grammar, and Parser dirs)type-bugAn unexpected behavior, bug, or error

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions