diff --git a/tokio/src/time/mod.rs b/tokio/src/time/mod.rs index 8aaf9c18cc4..a925de58e4e 100644 --- a/tokio/src/time/mod.rs +++ b/tokio/src/time/mod.rs @@ -54,35 +54,33 @@ //! # } //! ``` //! -//! A simple example using [`interval`] to execute a task every two seconds. -//! -//! The difference between [`interval`] and [`sleep`] is that an -//! [`interval`] measures the time since the last tick, which means that -//! `.tick().await` may wait for a shorter time than the duration specified -//! for the interval if some time has passed between calls to `.tick().await`. -//! -//! If the tick in the example below was replaced with [`sleep`], the task -//! would only be executed once every three seconds, and not every two -//! seconds. -//! -//! ``` -//! use tokio::time; -//! -//! async fn task_that_takes_a_second() { -//! println!("hello"); -//! time::sleep(time::Duration::from_secs(1)).await -//! } -//! -//! #[tokio::main] -//! async fn main() { -//! let interval = time::interval(time::Duration::from_secs(2)); -//! tokio::pin!(interval); -//! -//! for _i in 0..5 { -//! interval.as_mut().tick().await; -//! task_that_takes_a_second().await; -//! } -//! } +/// A simple example using `interval` to execute a task every two seconds. +/// +/// The difference between `interval` and [`sleep`] is that an `interval` +/// measures the time since the last tick, which means that `.tick().await` +/// may wait for a shorter time than the duration specified for the interval +/// if some time has passed between calls to `.tick().await`. +/// +/// If the tick in the example below was replaced with [`sleep`], the task +/// would only be executed once every three seconds, and not every two +/// seconds. +/// +/// ``` +/// use tokio::time; +/// +/// async fn task_that_takes_a_second() { +/// println!("hello"); +/// time::sleep(time::Duration::from_secs(1)).await +/// } +/// +/// #[tokio::main] +/// async fn main() { +/// let mut interval = time::interval(time::Duration::from_secs(2)); +/// for _i in 0..5 { +/// interval.tick().await; +/// task_that_takes_a_second().await; +/// } +/// } //! ``` //! //! [`sleep`]: crate::time::sleep()