From b218b373ca1ae9b6abc160e7baf4f7b06ff4176f Mon Sep 17 00:00:00 2001
From: Jan Srzednicki <w@wrzask.pl>
Date: Fri, 27 Oct 2023 11:32:14 +0200
Subject: [PATCH] docs: Document `tokio::time::sleep` usage (#66)

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

diff --git a/src/lib.rs b/src/lib.rs
index c097534..9c544eb 100644
--- 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.