From 98bb496198e18436e654ddca39358a4634ca32bd Mon Sep 17 00:00:00 2001 From: Jonathan Halterman Date: Sun, 9 Jun 2024 13:41:37 -0700 Subject: [PATCH] Doc update - fixes #384 --- core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java b/core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java index 6e2b2009..0d874e02 100644 --- a/core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java +++ b/core/src/main/java/dev/failsafe/CircuitBreakerBuilder.java @@ -271,7 +271,7 @@ private void assertFailureThresholdingPeriod(Duration failureThresholdingPeriod) * occur when in a HALF_OPEN state in order to close the circuit, else the circuit is re-opened when a failure * occurs. * - * @param successThreshold The number of consecutive successful executions that must occur in order to open the + * @param successThreshold The number of consecutive successful executions that must occur in order to close the * circuit * @throws IllegalArgumentException if {@code successThreshold} < 1 * @see CircuitBreakerConfig#getSuccessThreshold() @@ -285,7 +285,7 @@ public CircuitBreakerBuilder withSuccessThreshold(int successThreshold) { * HALF_OPEN state in order to close the circuit. For example: 5, 10 would close the circuit if 5 out of the last 10 * executions were successful. * - * @param successThreshold The number of successful executions that must occur in order to open the circuit + * @param successThreshold The number of successful executions that must occur in order to close the circuit * @param successThresholdingCapacity The capacity for storing execution results when performing success thresholding * @throws IllegalArgumentException if {@code successThreshold} < 1, {@code successThresholdingCapacity} < 1, or * {@code successThreshold} > {@code successThresholdingCapacity}