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

Jump to bottom

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

Closed
bdarnell opened this issue Nov 28, 2022 · 3 comments · Fixed by #100302
Closed

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

bdarnell opened this issue Nov 28, 2022 · 3 comments · Fixed by #100302
Labels
docs Documentation in the Doc dir expert-asyncio stdlib Python modules in the Lib dir

Comments

@bdarnell
Copy link
Contributor

bdarnell commented Nov 28, 2022 •
edited by bedevere-bot

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
@bdarnell bdarnell added the docs Documentation in the Doc dir label Nov 28, 2022
@hugovk hugovk added expert-asyncio stdlib Python modules in the Lib dir labels Nov 28, 2022
@kumaraditya303
Copy link
Contributor

kumaraditya303 commented Nov 29, 2022

Would you like to create a PR for this?

bdarnell added a commit to bdarnell/cpython that referenced this issue Dec 16, 2022
@bdarnell
pythongh-99830: asyncio: Document returns of remove_{reader,writer}
8842f42 
Fixes python#99830
@bdarnell bdarnell mentioned this issue Dec 16, 2022
Merged
@bdarnell
Copy link
Contributor Author

bdarnell commented Dec 16, 2022

Sure: #100302

gvanrossum pushed a commit that referenced this issue Dec 16, 2022
@bdarnell
gh-99830: asyncio: Document returns of remove_{reader,writer} (#100302)
5234e1c
@bedevere-bot bedevere-bot mentioned this issue Dec 16, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Dec 16, 2022
@bdarnell @miss-islington
pythongh-99830: asyncio: Document returns of remove_{reader,writer} (p…
9a25bb9 
…ythonGH-100302)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
@bedevere-bot bedevere-bot mentioned this issue Dec 16, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Dec 16, 2022
@bdarnell @miss-islington
pythongh-99830: asyncio: Document returns of remove_{reader,writer} (p…
fb54e42 
…ythonGH-100302)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
@gvanrossum
Copy link
Member

gvanrossum commented Dec 16, 2022

Thanks, Ben!

miss-islington added a commit that referenced this issue Dec 16, 2022
@miss-islington @bdarnell
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302
4c810f9 
)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
miss-islington added a commit that referenced this issue Dec 16, 2022
@miss-islington @bdarnell
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302
958be79 
)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
carljm added a commit to carljm/cpython that referenced this issue Dec 16, 2022
@carljm
Merge branch 'main' into fastmock
1b6241a 
* main:
  pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541)
  pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168)
  pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302)
  "Compound statement" docs: Fix with-statement step indexing (python#100286)
  pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir expert-asyncio stdlib Python modules in the Lib dir
Projects
asyncio
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-99830: asyncio: Document returns of remove_{reader,writer} bdarnell/cpython
4 participants
@bdarnell @hugovk @gvanrossum @kumaraditya303