retry: Extend Policy trait documentation (#690)

tower-rs · Sep 12, 2022 · 4362dfc · 4362dfc
1 parent b12f148
commit 4362dfc
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/tower/src/retry/policy.rs b/tower/src/retry/policy.rs
@@ -84,7 +84,8 @@ pub trait Policy<Req, Res, E> {
 
     /// Tries to clone a request before being passed to the inner service.
     ///
-    /// If the request cannot be cloned, return [`None`].
+    /// If the request cannot be cloned, return [`None`]. Moreover, the retry
+    /// function will not be called if the [`None`] is returned.
     fn clone_request(&mut self, req: &Req) -> Option<Req>;
 }