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

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

Merged
merged 1 commit into from
Dec 16, 2022
Merged
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -932,7 +932,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 @@ -945,7 +946,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