[hotfix][docs] Make timeout param of async i/o more clearer#26774
Merged
lincoln-lil merged 2 commits intoapache:masterfrom Jul 10, 2025
Merged
[hotfix][docs] Make timeout param of async i/o more clearer#26774lincoln-lil merged 2 commits intoapache:masterfrom
lincoln-lil merged 2 commits intoapache:masterfrom
Conversation
Collaborator
davidradl
reviewed
Jul 10, 2025
| - **Timeout**: The timeout defines how long an asynchronous operation take before it is finally considered failed, | ||
| may include multiple retry requests if retry enabled. This parameter guards against dead/failed requests. | ||
| - **Timeout**: The timeout defines the maximum duration from the first invocation to the final completion of an asynchronous operation, | ||
| This duration may include multiple retry attempts (if retries are enabled) and determines when the operation is ultimately considered failed. |
Contributor
There was a problem hiding this comment.
should we change:
is ultimately considered failed. -> is ultimately considered complete.
as the ### Timeout Handling section says we can call ResultFuture.complete() - implying a non failure completion after timeout.
Contributor
Author
There was a problem hiding this comment.
Make sense, updated
davidradl
approved these changes
Jul 10, 2025
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.
What is the purpose of the change
The current
timeoutparam might be not clear enough for users when enabling retries, as the code comment explains:Update this in the documentation.
Brief change log
Verifying this change
Does this pull request potentially affect one of the following parts:
Documentation