- Notifications
You must be signed in to change notification settings - Fork1.6k
Add missing TimeoutException to WaitAsync(TimeSpan, TimeProvider, CancellationToken) documentation#11481
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
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
…cellationToken) documentationCo-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
Task.WaitAsync(TimeSpan, TimeProvider, CancellationToken)
does not listTimeoutException
as a possible exceptionCopilot finished work on behalf ofjeffhandleyJune 19, 2025 07:07
jeffhandley approved these changesJun 20, 2025
gewarren approved these changesJun 30, 2025
8645ca1
intomain 12 of 14 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
The
Task.WaitAsync(TimeSpan, TimeProvider, CancellationToken)
method documentation had an inconsistency where the parameter description fortimeout
mentioned that aTimeoutException
would be thrown when the timeout expires, but this exception was not listed in the method's exceptions section.Before:
The exceptions section only listed:
ArgumentNullException
OperationCanceledException
After:
Added the missing
TimeoutException
with the description: "The timeout expired. This exception is stored into the returned task."This change ensures consistency between the parameter documentation and the exceptions section, making it clear to developers that they need to handle
TimeoutException
when using this method.The fix follows the same pattern used for other timeout-related exceptions in the codebase and maintains consistency with similar
WaitAsync
method overloads.Fixes#11190.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Clickhere to start the survey.