]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-99830: asyncio: Document returns of remove_{reader,writer} (#100302)
authorBen Darnell <ben@bendarnell.com>
Fri, 16 Dec 2022 19:04:55 +0000 (14:04 -0500)
committerGitHub <noreply@github.com>
Fri, 16 Dec 2022 19:04:55 +0000 (11:04 -0800)
Doc/library/asyncio-eventloop.rst

index fd47b0c24d8a16fb4f41aed65b8608e3b3ac7e84..470d1aa130e40f5df802b69990a6cf3fc585a9c4 100644 (file)
@@ -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.