Skip to content

Commit

Permalink
docs: Fix typo in is_err()
Browse files Browse the repository at this point in the history
Closes #203

Co-authored-by: John Nunley <[email protected]>
  • Loading branch information
pfumagalli and notgull authored May 30, 2024
1 parent 2af3a5e commit 7719966
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ impl Event {
/// In `epoll`, a TCP connection failure is indicated by `EPOLLERR` + `EPOLLHUP`, though just `EPOLLERR` is enough to indicate a connection failure.
/// EPOLLHUP may happen when we haven't event called `connect` on the socket, but it is still a valid event to check for.
///
/// Returns `Some(true)` if the connection has failed, `Some(false)` if there is an error,
/// Returns `Some(true)` if the connection has failed, `Some(false)` if there is no error,
/// or `None` if the platform does not support detecting this condition.
#[inline]
pub fn is_err(&self) -> Option<bool> {
Expand Down

0 comments on commit 7719966

Please sign in to comment.