Update readme (#35)

* Modify the comment for IsSuccessful * Update README
sony · Oct 21, 2021 · 602fbde · 602fbde
1 parent c8b8ad0
commit 602fbde
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ type Settings struct {
 	Timeout       time.Duration
 	ReadyToTrip   func(counts Counts) bool
 	OnStateChange func(name string, from State, to State)
+	IsSuccessful  func(err error) bool
 }
 ```
 
@@ -56,6 +57,11 @@ type Settings struct {
 
 - `OnStateChange` is called whenever the state of `CircuitBreaker` changes.
 
+- `IsSuccessful` is called with the error returned from a request.
+  If `IsSuccessful` returns true, the error is counted as a success.
+  Otherwise the error is counted as a failure.
+  If `IsSuccessful` is nil, default `IsSuccessful` is used, which returns false for all non-nil errors.
+
 The struct `Counts` holds the numbers of requests and their successes/failures:
 
 ```go

diff --git a/gobreaker.go b/gobreaker.go
@@ -99,9 +99,9 @@ func (c *Counts) clear() {
 //
 // OnStateChange is called whenever the state of the CircuitBreaker changes.
 //
-// IsSuccessful is called with the error returned from the request, if not nil.
-// If IsSuccessful returns false, the error is considered a failure, and is counted towards tripping the circuit breaker.
-// If IsSuccessful returns true, the error will be returned to the caller without tripping the circuit breaker.
+// IsSuccessful is called with the error returned from a request.
+// If IsSuccessful returns true, the error is counted as a success.
+// Otherwise the error is counted as a failure.
 // If IsSuccessful is nil, default IsSuccessful is used, which returns false for all non-nil errors.
 type Settings struct {
 	Name          string