Add comment for exported var DefaultExponential.

grpc · Aug 22, 2019 · 1c683d2 · 1c683d2
1 parent ab8d9e8
commit 1c683d2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/internal/backoff/backoff.go b/internal/backoff/backoff.go
@@ -51,6 +51,9 @@ const (
 	maxDelay = 120 * time.Second
 )
 
+// DefaultExponential is an exponential backoff implementation using the
+// default values for all the configurable knobs defined in
+// https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
 var DefaultExponential = Exponential{BaseDelay: baseDelay, Multiplier: factor, Jitter: jitter, MaxDelay: maxDelay}
 
 // Exponential implements exponential backoff algorithm as defined in