fix: correct jitter comment to reflect 25% scaling #2566
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates a comment in
src/openai/_base_client.pyto accurately describe the jitter applied to retry delays.Previously, the comment said "plus-or-minus half a second" when the code actually scales the delay down by up to 25% (it multiplies by 1 - 0.25 * random()). This can mislead readers. The new comment reads: "Apply jitter by scaling the delay down by up to 25% to spread retries and avoid thundering‑herd effects."
No functional changes are introduced – just a documentation fix.