Skip to content

[Concurrency] fix documentation typos in TaskGroup.swift #82291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 8, 2025

Conversation

Changhyun-Kyle
Copy link
Contributor

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"
    • This also maintains consistency with similar phrasing found on lines 367 and 654.
  • Fixed a markdown syntax typo:

    • "It`s guaranteed" → "It's guaranteed"
    • Using an apostrophe instead of a backtick is more appropriate in this context.

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.swift

Notes

These corrections are minor but contribute to maintaining the quality and polish of the standard library documentation.

@Changhyun-Kyle Changhyun-Kyle requested a review from ktoso as a code owner June 17, 2025 09:30
@ktoso
Copy link
Contributor

ktoso commented Jun 17, 2025

Thank you for the fix up

@ktoso
Copy link
Contributor

ktoso commented Jun 17, 2025

@swift-ci please smoke test

@ktoso ktoso enabled auto-merge June 17, 2025 10:10
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

@Changhyun-Kyle Changhyun-Kyle requested a review from ktoso July 7, 2025 05:40
@ktoso
Copy link
Contributor

ktoso commented Jul 7, 2025

@swift-ci please smoke test

@Changhyun-Kyle
Copy link
Contributor Author

Hi @ktoso

The "Swift Test Windows Platform" check is marked as failed with the message:

Build finished. No test results found.

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!

@ktoso
Copy link
Contributor

ktoso commented Jul 8, 2025

Well have run run the tests again

@ktoso
Copy link
Contributor

ktoso commented Jul 8, 2025

@swift-ci please smoke test windows

@ktoso ktoso merged commit bf61199 into swiftlang:main Jul 8, 2025
3 checks passed
@ktoso
Copy link
Contributor

ktoso commented Jul 8, 2025

Thanks for the contribution :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants