From 4a6d652dce3b9ce1076d2676bc8e0b7f980680ec Mon Sep 17 00:00:00 2001 From: Bipin Kumar Chaurasia Date: Sun, 30 Oct 2022 21:41:28 +0530 Subject: [PATCH] docs: Updated documentation on comments on DefaultCircuitBreaker args (#2135) --- .../iluwatar/circuitbreaker/DefaultCircuitBreaker.java | 8 ++++---- .../circuitbreaker/DefaultCircuitBreakerTest.java | 1 - 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DefaultCircuitBreaker.java b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DefaultCircuitBreaker.java index ba0ccdb28..935f67cd0 100644 --- a/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DefaultCircuitBreaker.java +++ b/circuit-breaker/src/main/java/com/iluwatar/circuitbreaker/DefaultCircuitBreaker.java @@ -45,10 +45,10 @@ public class DefaultCircuitBreaker implements CircuitBreaker { * Constructor to create an instance of Circuit Breaker. * * @param timeout Timeout for the API request. Not necessary for this simple example - * @param failureThreshold Number of failures we receive from the depended service before changing - * state to 'OPEN' - * @param retryTimePeriod Time period after which a new request is made to remote service for - * status check. + * @param failureThreshold Number of failures we receive from the depended on service before + * changing state to 'OPEN' + * @param retryTimePeriod Time, in nanoseconds, period after which a new request is made to + * remote service for status check. */ DefaultCircuitBreaker(RemoteService serviceToCall, long timeout, int failureThreshold, long retryTimePeriod) { diff --git a/circuit-breaker/src/test/java/com/iluwatar/circuitbreaker/DefaultCircuitBreakerTest.java b/circuit-breaker/src/test/java/com/iluwatar/circuitbreaker/DefaultCircuitBreakerTest.java index 161743cf4..2e19456a5 100644 --- a/circuit-breaker/src/test/java/com/iluwatar/circuitbreaker/DefaultCircuitBreakerTest.java +++ b/circuit-breaker/src/test/java/com/iluwatar/circuitbreaker/DefaultCircuitBreakerTest.java @@ -26,7 +26,6 @@ package com.iluwatar.circuitbreaker; import static org.junit.jupiter.api.Assertions.assertEquals; -import java.rmi.Remote; import org.junit.jupiter.api.Test; /**