]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 16 Dec 2022 19:15:12 +0000 (11:15 -0800)
committerGitHub <noreply@github.com>
Fri, 16 Dec 2022 19:15:12 +0000 (11:15 -0800)
(cherry picked from commit 5234e1cbea686e38392f113707db322ad8405048)

Co-authored-by: Ben Darnell <ben@bendarnell.com>
Doc/library/asyncio-eventloop.rst

index a23be64ec39a817aecdb499ec05ef6aa8dabe18c..7b4c3c7682fe04cdf1c9b7ebd2ce1dc4d493c79a 100644 (file)
@@ -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.