[Docs][Concurrency] TaskGroup docs: waitForAll (non-)cancellation #63956
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
ktoso
added
the
concurrency
|
@swift-ci please smoke test |
ktoso
changed the title
|
While in here is potted some wrong documentation... let me fix that. |
ktoso
changed the title
ktoso
changed the title
ktoso
force-pushed
the
wip-group-docs
branch
from
2711e37 to
29b9251
Compare
ktoso
commented
Feb 28, 2023
ktoso
changed the title
ktoso
changed the title
ktoso
force-pushed
the
wip-group-docs
branch
from
c06b05d to
7a67318
Compare
ktoso
commented
Feb 28, 2023
| /// ``` | ||
| /// | ||
| /// - Throws: The *first* error that was thrown by a child task during draining all the tasks. | ||
| /// This first error is stored until all other tasks have completed, and is re-thrown afterwards. |
There was a problem hiding this comment.
This is the only instance of waitForAll which has such special semantics.
Discarding groups don't have this API, nor can they use next(), and a not throwing one cannot throw so this cannot happen
|
@swift-ci please smoke test |
lurdbinanc
approved these changes
Feb 28, 2023
FranzBusch
approved these changes
Feb 28, 2023
JJJensen
reviewed
Mar 6, 2023
| /// } catch is CancellationError { | ||
| /// // we decide that cancellation errors thrown by children, | ||
| /// // should not cause cancellation of the entire group. | ||
| /// continue; |
| /// // should not cause cancellation of the entire group. | ||
| /// continue; | ||
| /// } catch { | ||
| /// // other errors though we print and cancel the group, |
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.
Resolves rdar://105973001
This behavior is expected, however was not documented so a bug fix of the group previously not properly awaiting all tasks now made this behavior surprising. The solution is not to change the behavior, but to make it documented.
Please review @FranzBusch