Clarify TimeoutBody documentation #574
Merged
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
|
Thanks for improving the docs! I'm always for making things clearer. One question: does the following existing line say something similar?
Should the lines be collapsed somehow? |
@seanmonstar You are right, I've updated it. Let me know what you think! |
seanmonstar
approved these changes
May 30, 2025
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.
Adds a couple of clarifying lines to the
TimeoutBodydocumentation to explain that the timeout applies to the time interval between frame polls, as opposed to the entirety of the body.Motivation
I was confused about why the timeout was not being triggered even though the time it took to stream the response was longer than the timeout. It wasn't until I looked at what the code was doing that I realized why the timeout was not being triggered.