docs: add XML doc comments on WhenAll exception behavior (fixes #514)#717
Open
YIMO691 wants to merge 1 commit into
Open
docs: add XML doc comments on WhenAll exception behavior (fixes #514)#717YIMO691 wants to merge 1 commit into
YIMO691 wants to merge 1 commit into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Add XML documentation comments to
WhenAllandWhenAll<T>methods clarifying the behavioral difference from standard .NETTask.WhenAll.Problem (Issue #514)
UniTask.WhenAllexits immediately when any task throws an exception, unlike .NETTask.WhenAllwhich waits for ALL tasks to complete and wraps errors inAggregateException.Root Cause
In
WhenAllPromise<T>.TryInvokeContinuation()(WhenAll.cs L101-117):core.TrySetException(ex); return;— immediately completes the promiseFix
Added XML doc comments on
WhenAll/WhenAll<T>:<summary>: Documents that WhenAll completes immediately on first exception<remarks>: Explains the difference from .NET Task.WhenAll and suggests workarounds (try-catch wrapper, SuppressCancellationThrow)Changes
UniTask.WhenAll.cs: +15 lines (XML doc only, no behavior change)Closes #514
🤖 Generated with Claude Code