Skip to content

[3.11] gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302) #100304

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.

Sign up for GitHub

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

Merged
miss-islington merged 1 commit into from
Dec 16, 2022
+4 −2
Merged

[3.11] gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302) #100304

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302 
)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
  • Loading branch information
@bdarnell @miss-islington
bdarnell authored and miss-islington committed Dec 16, 2022
commit fb54e42d9933a05a0c5498aeb71773a5e718fd4b
6 changes: 4 additions & 2 deletions Doc/library/asyncio-eventloop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -915,7 +915,8 @@ Watching file descriptors

.. method:: loop.remove_reader(fd)

Stop monitoring the *fd* file descriptor for read availability.
Stop monitoring the *fd* file descriptor for read availability. Returns
``True`` if *fd* was previously being monitored for reads.

.. method:: loop.add_writer(fd, callback, *args)

Expand All @@ -928,7 +929,8 @@ Watching file descriptors

.. method:: loop.remove_writer(fd)

Stop monitoring the *fd* file descriptor for write availability.
Stop monitoring the *fd* file descriptor for write availability. Returns
``True`` if *fd* was previously being monitored for writes.

See also :ref:`Platform Support <asyncio-platform-support>` section
for some limitations of these methods.
Expand Down