From c6b5f13adf67483d927b1766faf984c1871e8abc Mon Sep 17 00:00:00 2001
From: Thomas de Zeeuw <thomasdezeeuw@gmail.com>
Date: Wed, 10 Aug 2022 14:10:41 +0200
Subject: [PATCH] Document the current Poll::poll timeout behaviour

---
 src/poll.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/poll.rs b/src/poll.rs
index 603ff4d40..289d6686c 100644
--- a/src/poll.rs
+++ b/src/poll.rs
@@ -349,6 +349,10 @@ impl Poll {
     /// of Mio would automatically retry the poll call if it was interrupted
     /// (if `EINTR` was returned).
     ///
+    /// Currently if the `timeout` elapses without any readiness events
+    /// triggering this will return `Ok(())`. However we're not guaranteeing
+    /// this behaviour as this depends on the OS.
+    ///
     /// # Examples
     ///
     /// A basic example -- establishing a `TcpStream` connection.