Clarify Task.WhenAny documentation to address user confusion about Task<Task> return type #48051
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 documentation for
Task.WhenAny
in the async programming guide was causing confusion for readers who couldn't understand the difference between "the two tasks" mentioned in the explanation. The issue was that the explanation didn't clearly distinguish between:Task<Task>
returned byTask.WhenAny
Changes Made
Updated the explanation in the "Apply await expressions to tasks efficiently" section to more clearly explain:
Task.WhenAny
returns aTask<Task>
- a wrapper task that contains the completed taskBefore
After
The new explanation uses clearer language and explicitly mentions the
Task<Task>
wrapper concept to help readers understand why there are "two tasks" involved and why both await operations are necessary.Fixes #44497.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.
Internal previews