Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve exponential_sleep_generator docstring #570

Open
daniel-sanche opened this issue Dec 8, 2023 · 0 comments
Open

Improve exponential_sleep_generator docstring #570

daniel-sanche opened this issue Dec 8, 2023 · 0 comments
Labels
type: docs Improvement to the documentation for an API.

Comments

@daniel-sanche
Copy link
Contributor

Context in this thread

doc: This link only calls it "exponential backoff" (without "truncation" in the title). It links to the Wikipedia page, which does mention "truncated exponential backoff". However, what you're doing with the use of random is what I guess Wikipedia would call "truncated randomized exponential backoff". So I suggest:

  1. In the comment: call this "truncated randomized exponential backoff"
  2. Link to the Wikipedia article instead (or in addition to the current link).

Link to code
@daniel-sanche daniel-sanche mentioned this issue Dec 8, 2023
Merged
@parthea parthea added the type: docs Improvement to the documentation for an API. label Dec 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@daniel-sanche @parthea