Skip to content

Commit

Permalink
pythongh-99830: asyncio: Document returns of remove_{reader,writer}
Browse files Browse the repository at this point in the history
  • Loading branch information
bdarnell committed Dec 16, 2022
1 parent f23236a commit 8842f42
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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.
Expand Down

0 comments on commit 8842f42

Please sign in to comment.