gh-99830: asyncio: Document returns of remove_{reader,writer} (#100302)

This commit is contained in:
Ben Darnell 2022-12-16 14:04:55 -05:00 committed by GitHub
parent f23236a92d
commit 5234e1cbea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View 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.