review fix

CHANGELOG.md

@@ -1,3 +1,7 @@
+# Version 3.5.0
+
+- Use the `epoll` backend when RedoxOS is enabled. (#190)
+
 # Version 3.4.0
 
 - Add the ability to identify whether socket connection has failed. (#185)

Cargo.toml

@@ -3,7 +3,7 @@ name = "polling"
 # When publishing a new version:
 # - Update CHANGELOG.md
 # - Create "v3.x.y" git tag
-version = "3.4.0"
+version = "3.5.0"
 authors = ["Stjepan Glavina <[email protected]>", "John Nunley <[email protected]>"]
 edition = "2021"
 rust-version = "1.63"

src/lib.rs

@@ -404,7 +404,9 @@ impl Event {
     /// This function checks if an error exist,particularlly useful in detecting if TCP connection failed. It corresponds to the `EPOLLERR` event in Linux
     /// and `CONNECT_FAILED` event in Windows IOCP.
     ///
-    /// note: in epoll, a tcp connection failure is indicated by EPOLLERR + EPOLLHUP, though just EPOLLERR is enough to indicate a connection failure.
+    /// ## Caveats
+    ///
+    /// 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,