Skip to content

Commit

Permalink
io: fix docs referring to clear_{read,write}_ready (#3957)
Browse files Browse the repository at this point in the history
  • Loading branch information
blasrodri committed Jul 20, 2021
1 parent 2520048 commit 5ae2855
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions tokio/src/io/poll_evented.rs
Expand Up @@ -40,9 +40,8 @@ cfg_io_driver! {
/// [`poll_read_ready`] again will also indicate read readiness.
///
/// When the operation is attempted and is unable to succeed due to the I/O
/// resource not being ready, the caller must call `clear_read_ready` or
/// `clear_write_ready`. This clears the readiness state until a new
/// readiness event is received.
/// resource not being ready, the caller must call `clear_readiness`.
/// This clears the readiness state until a new readiness event is received.
///
/// This allows the caller to implement additional functions. For example,
/// [`TcpListener`] implements poll_accept by using [`poll_read_ready`] and
Expand Down

0 comments on commit 5ae2855

Please sign in to comment.