docs(quickstart): clarify timeout applies to connect and read separately#7373
Closed
docs(quickstart): clarify timeout applies to connect and read separately#7373
Conversation
The quickstart timeout section didn't explain that a single float value applies to both connect and read timeouts independently, or that a tuple can be used to set them separately. Added a brief clarification with a cross-reference to the advanced timeouts section.
alokshukla631
left a comment
alokshukla631
left a comment
There was a problem hiding this comment.
Nice clarification. This makes the quickstart timeout note a lot less ambiguous, and the link to the detailed timeouts section is helpful.
nateprewitt
added
the
mass-automation-pr
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
3 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.
The quickstart timeout note explains that
timeoutis not a time limit on the entire response download, but does not mention that a single float applies to both connect and read timeouts independently, or that a(connect_timeout, read_timeout)tuple can set them separately.Added a brief clarification to the existing admonition block in
docs/user/quickstart.rstwith a cross-reference to the advanced timeouts section, which already documents this behavior in detail.Fixes #7350