Skip to content

asyncio: Document return values of AbstractEventLoop.remove_{reader,writer} #99830

Closed
#100302
Closed
asyncio: Document return values of AbstractEventLoop.remove_{reader,writer}#99830
#100302
Labels
docsDocumentation in the Doc dirstdlibStandard Library Python modules in the Lib/ directorytopic-asyncio

Description

@bdarnell
bdarnell
opened on Nov 28, 2022

Documentation

According to python/typeshed#7042, AbstractEventLoop.remove_{reader,writer} return a bool, but there is no indication of this in the documentation for these methods. These return values need to be documented so that subclass implementors can know how to implement them appropriately.

Linked PRs

Activity

  1. bdarnell
    added
    docsDocumentation in the Doc dir
    on Nov 28, 2022
  2. hugovk
    added
    topic-asyncio
    stdlibStandard Library Python modules in the Lib/ directory
    on Nov 28, 2022
  3. ezio-melotti
    added this to asyncioon Nov 28, 2022
  4. ezio-melotti
    moved this to Todo in asyncioon Nov 28, 2022

  5. kumaraditya303 commented on Nov 29, 2022

    @kumaraditya303
    kumaraditya303
    on Nov 29, 2022
    Contributor

    Would you like to create a PR for this?

  6. bdarnell
    added a commit that references this issue on Dec 16, 2022

    pythongh-99830: asyncio: Document returns of remove_{reader,writer}

    8842f42

  7. bdarnell commented on Dec 16, 2022

    @bdarnell
    bdarnell
    on Dec 16, 2022
    ContributorAuthor

    Sure: #100302

  8. gvanrossum
    closed this as completedin #100302on Dec 16, 2022
  9. Repository owner moved this from Todo to Done in asyncioon Dec 16, 2022
  10. gvanrossum
    added a commit that references this issue on Dec 16, 2022

    gh-99830: asyncio: Document returns of remove_{reader,writer} (#100302)

    5234e1c
  11. miss-islington
    added 2 commits that reference this issue on Dec 16, 2022

    pythongh-99830: asyncio: Document returns of remove_{reader,writer} (p…

    9a25bb9

    pythongh-99830: asyncio: Document returns of remove_{reader,writer} (p…

    fb54e42

  12. gvanrossum commented on Dec 16, 2022

    @gvanrossum
    gvanrossum
    on Dec 16, 2022
    Member

    Thanks, Ben!

  13. miss-islington
    added 2 commits that reference this issue on Dec 16, 2022

    gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302

    4c810f9

    gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302

    958be79
  14. carljm
    added a commit that references this issue on Dec 16, 2022

    Merge branch 'main' into fastmock

    1b6241a
  15. shihai1991
    added a commit that references this issue on Dec 18, 2022

    Merge remote-tracking branch 'origin/main' into bpo_34697

    2878571
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

    docsDocumentation in the Doc dirstdlibStandard Library Python modules in the Lib/ directorytopic-asyncio

    Projects

    • asyncio
      Status
      Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions