{{ message }}
Fix misleading max_retries docstring in http_backoff#4436
Merged
Conversation
Contributor
Author
Contributor
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
2 participants
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.
Small docs fix. The
max_retriesdocstring inhttp_backoffandhttp_stream_backoffsays it "defaults to 5 (no retries)", which doesn't add up - 5 means 5 retries, not none. Looks like a leftover from when the default usedto be 0. I updated both to say the default is 5, and to mention you can pass
0if you actually want to turn retries off.Note
Low Risk
Documentation-only change with no runtime behavior impact.
Overview
Corrects the
max_retriesargument documentation onhttp_backoffandhttp_stream_backoffin_http.py.The old text claimed the default is 5 while also saying “(no retries)”, which contradicts the implementation (default 5 retries,
0disables retries). Both docstrings now state that the default is 5 and thatmax_retries=0turns retries off.Reviewed by Cursor Bugbot for commit b1a325c. Bugbot is set up for automated code reviews on this repo. Configure here.