[6.2][Docs] TaskGroup docs improvements & reorganization #82984
Merged
+140
−94
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
These looks like the side effect of a find-and-replace for PR 82558 fixing 'cancelled' vs 'canceled'.
- Move the definition of 'structured concurrency' to the beginning of the section. - Avoid future tense. Fix some mixed future+present tense errors. - Write bullet points as individual sentences, not as the clauses of one long sentence. - Apple Style: Use 'since' only in the sense of 'after'. - Apple Style: Use 'you' instead of 'one'. - Apple Style: Close up 'non-' except when ambiguous. - DevPubs style: Avoid bare 'this' for clarity. Here, 'this guarantee' tells the reader what 'this' refers to. - DevPubs style: Avoid 'may' which can be ambiguous between possibility and permission.
|
@swift-ci please test |
ktoso
force-pushed
the
pick-task-group-docs
branch
from
f7c0344 to
12b998e
Compare
|
@swift-ci please test |
hborla
approved these changes
Jul 11, 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.
Description: This is a docs only change, which reorganizes docs and fixes some inconsistencies which have caused developers some confusion. It isn't a whole reword but already improves the experience significantly.
We lean into documenting detailed behavior in one place, rather than on every group which often one of them got "missed" when updating documentation. This explains better cancellation behavior, and for the first time we actually properly explain structured concurrency benefits on the API docs of the group.
Scope/Impact: Docs only change to improve
Risk: Low, docs only.
Testing: CI testing
Reviewed by: @amartini51 @DougGregor
Original PR: #82291 #82894 #82558
Radar: rdar://154000871 #82396