diff --git a/src/future/timeout.rs b/src/future/timeout.rs index cf146aeb..eb7d8ba1 100644 --- a/src/future/timeout.rs +++ b/src/future/timeout.rs @@ -10,6 +10,9 @@ use crate::task::{Context, Poll}; /// Awaits a future or times out after a duration of time. /// +/// If you want to await an I/O future consider using +/// [`io::timeout`](../io/fn.timeout.html) instead. +/// /// # Examples /// /// ``` diff --git a/src/io/timeout.rs b/src/io/timeout.rs index 6d777376..2d1b29e7 100644 --- a/src/io/timeout.rs +++ b/src/io/timeout.rs @@ -7,6 +7,9 @@ use crate::io; /// Awaits an I/O future or times out after a duration of time. /// +/// If you want to await a non I/O future consider using +/// [`future::timeout`](../future/fn.timeout.html) instead. +/// /// # Examples /// /// ```no_run