Skip to content

Declare Swift 6.1 availability for TestScoping-related APIs #927

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 2 commits into from
Jan 27, 2025

Conversation

stmontgomery
Copy link
Contributor

The TestScoping protocol and its related APIs have been introduced in Swift 6.1, so this annotates their availability accordingly.

Once this PR lands, I will cherry-pick it to the release/6.1 branch as well.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

@stmontgomery stmontgomery added documentation 📚 Improvements or additions to documentation public-api Affects public API traits Issues and PRs related to the trait subsystem or built-in traits labels Jan 26, 2025
@stmontgomery stmontgomery added this to the Swift 6.x milestone Jan 26, 2025
@stmontgomery stmontgomery self-assigned this Jan 26, 2025
@stmontgomery
Copy link
Contributor Author

@swift-ci please test

@grynspan
Copy link
Contributor

We may need to continue to use sidecar files for this until there's an official release with the relevant DocC fix. I believe swiftpackageindex.com won't ingest this correctly.

…ender documentation won't be able to upgrade DocC until the next Swift release
@stmontgomery
Copy link
Contributor Author

We may need to continue to use sidecar files for this until there's an official release with the relevant DocC fix. I believe swiftpackageindex.com won't ingest this correctly.

Fair enough. The sidecar files are quite a chore to write! Can't wait for swiftlang/swift-docc#1107

@grynspan
Copy link
Contributor

Indeed, I'm not a fan of them either! Glad we'll be able to ditch them soonish.

@stmontgomery
Copy link
Contributor Author

@swift-ci please test

@stmontgomery stmontgomery merged commit 33ea4dd into swiftlang:main Jan 27, 2025
3 checks passed
@stmontgomery stmontgomery deleted the TestScoping-availability branch January 27, 2025 19:57
stmontgomery added a commit to stmontgomery/swift-testing that referenced this pull request Jan 27, 2025
stmontgomery added a commit that referenced this pull request Jan 27, 2025
- **Explanation**: Declare Swift 6.1 availability for
TestScoping-related APIs
  - **Scope**: Documentation
  - **Issues**: n/a
- **Original PRs**: #927
  - **Risk**: Low
  - **Testing**: n/a, documentation only
  - **Reviewers**: @grynspan
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📚 Improvements or additions to documentation public-api Affects public API traits Issues and PRs related to the trait subsystem or built-in traits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants