[Concurrency] fix documentation typos in TaskGroup.swift #82291
Merged
+2
−2
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
approved these changes
Jun 17, 2025
Contributor
|
Thank you for the fix up |
Contributor
|
@swift-ci please smoke test |
Corrects upHeap and downHeap index calculations: - upHeap: parentNdx = (theNdx - 1) / 2 instead of theNdx / 2 - downHeap: leftNdx = 2 * theNdx + 1 instead of 2 * theNdx - downHeap: rightNdx = 2 * theNdx + 2 instead of 2 * theNdx + 1 The previous 1-based indexing formulas caused incorrect heap property maintenance in 0-based arrays, leading to potential heap violations.
auto-merge was automatically disabled
June 18, 2025 04:19
Head branch was pushed to by a user without write access
…d arrays" This reverts commit a1e62c7.
Contributor
|
@swift-ci please smoke test |
ktoso
approved these changes
Jul 7, 2025
Contributor
Author
|
Hi @ktoso The "Swift Test Windows Platform" check is marked as failed with the message:
From what I can see, the build itself completed successfully, but the test results were either not generated or not collected. Is this something I should address on my end, or is it a known issue with the Windows CI setup? Thanks in advance! |
Contributor
|
Well have run run the tests again |
Contributor
|
@swift-ci please smoke test windows |
Contributor
|
Thanks for the contribution :-) |
ktoso
pushed a commit
to ktoso/swift
that referenced
this pull request
Jul 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR fixes small documentation issues in
TaskGroup.swift:Corrected a grammatical error:
"Awaiting on an empty group immediate returns nil"→"immediately returns nil"lines 367and654.Fixed a markdown syntax typo:
Motivation
Improves clarity and readability of developer-facing documentation comments. This is a non-functional change that does not affect compilation or behavior.
Affected File
stdlib/public/Concurrency/TaskGroup.swiftNotes
These corrections are minor but contribute to maintaining the quality and polish of the standard library documentation.