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

miss-islington webhook-mailer at python.org
Fri Dec 16 14:14:34 EST 2022


https://github.com/python/cpython/commit/4c810f92baed7562e7f2da0c70e2edac2e89bf75
commit: 4c810f92baed7562e7f2da0c70e2edac2e89bf75
branch: 3.11
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:14:28-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 28b7a900583b..d32e848a8413 100644
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -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)
 
@@ -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.



More information about the Python-checkins mailing list