Document Join APIs that may propagate exceptions #1332
Merged
Conversation
This file contains 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
lifengl
approved these changes
Jul 9, 2024
| @@ -145,13 +145,19 @@ public JoinRelease Join() | |||
| /// Joins the caller's context to this collection till the collection is empty. | |||
| /// </summary> | |||
| /// <returns>A task that completes when this collection is empty.</returns> | |||
| /// <remarks> | |||
| /// Any exceptions thrown by the tasks in this collection are <em>not</em> propagated to the returned task. | |||
There was a problem hiding this comment.
I wonder it should be 'Any exception' instead of 'Any exceptions'
| public Task JoinTillEmptyAsync() => this.JoinTillEmptyAsync(CancellationToken.None); | ||
|
|
||
| /// <summary> | ||
| /// Joins the caller's context to this collection till the collection is empty. | ||
| /// </summary> | ||
| /// <param name="cancellationToken">A cancellation token.</param> | ||
| /// <returns>A task that completes when this collection is empty, or is canceled when <paramref name="cancellationToken"/> is canceled.</returns> | ||
| /// <remarks> | ||
| /// Any exceptions thrown by the tasks in this collection are <em>not</em> propagated to the returned task. |
There was a problem hiding this comment.
the same as the previous comment.
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.
No description provided.