Skip to content

Commit 98bb496

Browse files
committed
Doc update - fixes #384
1 parent ceb14ac commit 98bb496

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ private void assertFailureThresholdingPeriod(Duration failureThresholdingPeriod)
271271
* occur when in a HALF_OPEN state in order to close the circuit, else the circuit is re-opened when a failure
272272
* occurs.
273273
*
274-
* @param successThreshold The number of consecutive successful executions that must occur in order to open the
274+
* @param successThreshold The number of consecutive successful executions that must occur in order to close the
275275
* circuit
276276
* @throws IllegalArgumentException if {@code successThreshold} < 1
277277
* @see CircuitBreakerConfig#getSuccessThreshold()
@@ -285,7 +285,7 @@ public CircuitBreakerBuilder<R> withSuccessThreshold(int successThreshold) {
285285
* HALF_OPEN state in order to close the circuit. For example: 5, 10 would close the circuit if 5 out of the last 10
286286
* executions were successful.
287287
*
288-
* @param successThreshold The number of successful executions that must occur in order to open the circuit
288+
* @param successThreshold The number of successful executions that must occur in order to close the circuit
289289
* @param successThresholdingCapacity The capacity for storing execution results when performing success thresholding
290290
* @throws IllegalArgumentException if {@code successThreshold} < 1, {@code successThresholdingCapacity} < 1, or
291291
* {@code successThreshold} > {@code successThresholdingCapacity}

0 commit comments

Comments
 (0)