From d68d6bb05226c72f33927ca394160991dcd81a8d Mon Sep 17 00:00:00 2001 From: Yoshua Wuyts Date: Fri, 13 Sep 2019 17:58:03 +0200 Subject: [PATCH] links the timeout docs to each other Signed-off-by: Yoshua Wuyts --- src/future/timeout.rs | 3 +++ src/io/timeout.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/src/future/timeout.rs b/src/future/timeout.rs index cf146ae..eb7d8ba 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 6d77737..2d1b29e 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