Improve the description of WithInfiniteRetry()

eapache · Dec 13, 2023 · 3c5b8c6 · 3c5b8c6
1 parent 1d4a97f
commit 3c5b8c6
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/retrier/retrier.go b/retrier/retrier.go
@@ -35,7 +35,9 @@ func New(backoff []time.Duration, class Classifier) *Retrier {
 	}
 }
 
-// WithInfiniteRetry set the retrier to loop infinitely on the last backoff duration
+// WithInfiniteRetry set the retrier to loop infinitely on the last backoff duration. Using this option,
+// the program will not exit until the retried function has been executed successfully.
+// WARNING : This may run indefinitely.
 func (r *Retrier) WithInfiniteRetry() *Retrier {
 	r.infiniteRetry = true
 	return r