summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorBen Darnell <ben@bendarnell.com>2022-12-16 19:04:55 (GMT)
committerGitHub <noreply@github.com>2022-12-16 19:04:55 (GMT)
commit5234e1cbea686e38392f113707db322ad8405048 (patch)
tree75a37b98a1509fe324ccc144faebc78c247632b7 /Doc/library
parentf23236a92d8796ae91772adaf27c3485fda963e8 (diff)
downloadcpython-5234e1cbea686e38392f113707db322ad8405048.zip
cpython-5234e1cbea686e38392f113707db322ad8405048.tar.gz
cpython-5234e1cbea686e38392f113707db322ad8405048.tar.bz2
gh-99830: asyncio: Document returns of remove_{reader,writer} (#100302)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/asyncio-eventloop.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
index fd47b0c..470d1aa 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -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)
@@ -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.