Skip to content

Commit

Permalink
Update documentation for default value in Backoff.exponential where m…
Browse files Browse the repository at this point in the history
…ultiplier is not specified (#5925)

Motivation:

Docs were confusing when using the framework. Needed to dig into the
code to find the default multipler. So let's add it in the documentation
  • Loading branch information
roderick675 authored Oct 10, 2024
1 parent cfd5c62 commit 9beb8cb
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ static Backoff fixed(long delayMillis) {
}

/**
* Returns a {@link Backoff} that waits an exponentially-increasing amount of time between attempts.
* Returns a {@link Backoff} that waits an exponentially-increasing with multiplier
* 2.0 amount of time between attempts.
*/
static Backoff exponential(long initialDelayMillis, long maxDelayMillis) {
return exponential(initialDelayMillis, maxDelayMillis, 2.0);
Expand Down

0 comments on commit 9beb8cb

Please sign in to comment.