[Python-checkins] gh-99830: asyncio: Document returns of remove_{reader, writer} (GH-100302)
miss-islington
webhook-mailer at python.org
Fri Dec 16 14:15:18 EST 2022
https://github.com/python/cpython/commit/958be792a7fd50971a048662a377f4ae101652bd
commit: 958be792a7fd50971a048662a377f4ae101652bd
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-12-16T11:15:12-08:00
summary:
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)
(cherry picked from commit 5234e1cbea686e38392f113707db322ad8405048)
Co-authored-by: Ben Darnell <ben at bendarnell.com>
files:
M Doc/library/asyncio-eventloop.rst
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index a23be64ec39a..7b4c3c7682fe 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -858,7 +858,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)
@@ -871,7 +872,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.
More information about the Python-checkins
mailing list