docs: add reference to backon

yetanotherco · Oct 28, 2024 · 7da5d3e · 7da5d3e
1 parent 56388b1
commit 7da5d3e
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/batcher/aligned-batcher/src/retry/mod.rs b/batcher/aligned-batcher/src/retry/mod.rs
@@ -30,6 +30,7 @@ impl<E> RetryError<E> {
 
 impl<E: std::fmt::Display> std::error::Error for RetryError<E> where E: std::fmt::Debug {}
 
+// Supports retries only on async functions. See: https://docs.rs/backon/latest/backon/#retry-an-async-function
 pub async fn retry_function<FutureFn, Fut, T, E>(
     function: FutureFn,
     min_delay: u64,