doc: remove obsolute timeout option for circuitbreaker

sunng87 · Oct 9, 2024 · 1af9762 · 1af9762
1 parent f9fb095
commit 1af9762
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 5 deletions.
diff --git a/src/diehard/circuit_breaker.clj b/src/diehard/circuit_breaker.clj
@@ -10,7 +10,7 @@
   #{:failure-threshold :failure-threshold-ratio :failure-threshold-ratio-in-period
     :failure-rate-threshold-in-period
     :success-threshold :success-threshold-ratio
-    :delay-ms :timeout-ms
+    :delay-ms
 
     :fail-if :fail-on :fail-when
 

diff --git a/src/diehard/core.clj b/src/diehard/core.clj
@@ -366,10 +366,6 @@ retry block.
 * `:fail-if`
 * `:fail-on`
 * `:fail-when`
-* `:timeout-ms` while give all you code a timeout is best practice in
-  application level, circuit breaker also provides a timeout for
-  marking a long running block as failure
-
 
 ##### Delay and threshold