Skip to content

Commit

Permalink
gh-99830: asyncio: Document returns of remove_{reader,writer} (GH-100302
Browse files Browse the repository at this point in the history
)

(cherry picked from commit 5234e1c)

Co-authored-by: Ben Darnell <[email protected]>
  • Loading branch information
miss-islington and bdarnell authored Dec 16, 2022
1 parent 0f61020 commit 958be79
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 @@ -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)

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

0 comments on commit 958be79

Please sign in to comment.