Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cenkalti committed Dec 19, 2024
1 parent 7fa6f71 commit 43ce21d
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The retries exponentially increase and stop increasing when a certain threshold

Import path is `github.com/cenkalti/backoff/v5`. Please note the version part at the end.

For most cases, use [`Retry`][retry-doc] function. See [example_test.go][example] for an example.
For most cases, use `Retry` function. See [example_test.go][example] for an example.

If you have specific needs, copy the [`Retry`][retry-src] function into your code and modify it as needed.

Expand All @@ -29,6 +29,5 @@ If you have specific needs, copy the [`Retry`][retry-src] function into your cod
[google-http-java-client]: https://github.com/google/google-http-java-client/blob/da1aa993e90285ec18579f1553339b00e19b3ab5/google-http-client/src/main/java/com/google/api/client/util/ExponentialBackOff.java
[exponential backoff wiki]: http://en.wikipedia.org/wiki/Exponential_backoff

[retry-doc]: https://pkg.go.dev/github.com/cenkalti/backoff/v5#Retry
[retry-src]: https://github.com/cenkalti/backoff/blob/v5/retry.go
[example]: https://github.com/cenkalti/backoff/blob/v5/example_test.go

0 comments on commit 43ce21d

Please sign in to comment.