docs: Document tokio::time::sleep usage (#66)

Xuanwo · Oct 27, 2023 · b218b37 · b218b37
1 parent 7881c72
commit b218b37
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -14,6 +14,10 @@
 //! - [`ExponentialBackoff`]: backoff with exponential delay, also provides jitter supports.
 //! - [`FibonacciBackoff`]: backoff with fibonacci delay, also provides jitter supports.
 //!
+//! Internally, `tokio::time::sleep()` will be used to sleep between retries, therefore
+//! it will respect [pausing/auto-advancing](https://docs.rs/tokio/latest/tokio/time/fn.pause.html)
+//! tokio's Runtime semantics, if enabled.
+//!
 //! # Examples
 //!
 //! Retry with default settings.