Add missing TimeoutException to WaitAsync(TimeSpan, TimeProvider, CancellationToken) documentation #11481
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) documentation Co-authored-by: jeffhandley <[email protected]>
Copilot
AI
changed the title
Task.WaitAsync(TimeSpan, TimeProvider, CancellationToken) does not list TimeoutException as a possible exception
Copilot finished work on behalf of
jeffhandley
June 19, 2025 07:07
jeffhandley
approved these changes
Jun 20, 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.
The
Task.WaitAsync(TimeSpan, TimeProvider, CancellationToken)method documentation had an inconsistency where the parameter description fortimeoutmentioned that aTimeoutExceptionwould be thrown when the timeout expires, but this exception was not listed in the method's exceptions section.Before:
The exceptions section only listed:
ArgumentNullExceptionOperationCanceledExceptionAfter:
Added the missing
TimeoutExceptionwith 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
TimeoutExceptionwhen using this method.The fix follows the same pattern used for other timeout-related exceptions in the codebase and maintains consistency with similar
WaitAsyncmethod overloads.Fixes #11190.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.