Skip to content

Enable the Docs soundness check #1314

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.

Sign up for GitHub

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 4 commits into from
Sep 17, 2025
Merged

Enable the Docs soundness check #1314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2bfb7ab
Enable the Docs soundness check
stmontgomery Sep 12, 2025
4b536b7
Fix issues
stmontgomery Sep 16, 2025
8b91287
Fix link style
stmontgomery Sep 16, 2025
42f9605
Switch to official 6.2 container, now
stmontgomery Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pull_request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ jobs:
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
with:
license_header_check_project_name: "Swift"
docs_check_enabled: false
docs_check_container_image: "swift:6.2-noble"
format_check_enabled: false
api_breakage_check_enabled: false
6 changes: 2 additions & 4 deletions Sources/Testing/Testing.docc/Documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,8 @@ their problems.

#### Related videos

@Links(visualStyle: compactGrid) {
- <doc://com.apple.documentation/videos/play/wwdc2024/10179>
- <doc://com.apple.documentation/videos/play/wwdc2024/10195>
}
- [Meet Swift Testing](https://developer.apple.com/videos/play/wwdc2024/10179)
- [Go further with Swift Testing](https://developer.apple.com/videos/play/wwdc2024/10195)

## Topics

Expand Down
8 changes: 5 additions & 3 deletions Sources/Testing/Testing.docc/MigratingFromXCTest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,9 +556,11 @@ test function with an instance of this trait type to control whether it runs:
}
}

<!-- TODO: document Test.cancel() and Test.Case.cancel() here
<!-- TODO: document Test.cancel() and Test.Case.cancel() here, and update
relevant links to use proper DocC symbol references.

If a test has already started running and you determine it cannot complete and
should end early without failing, use ``Test/cancel(_:sourceLocation:)`` instead
should end early without failing, use `Test/cancel(_:sourceLocation:)` instead
of [`XCTSkip`](https://developer.apple.com/documentation/xctest/xctskip) to
cancel the task associated with the current test:

Expand Down Expand Up @@ -592,7 +594,7 @@ cancel the task associated with the current test:
}

If the test is parameterized and you only want to cancel the current test case
rather than the entire test, use ``Test/Case/cancel(_:sourceLocation:)``.
rather than the entire test, use `Test/Case/cancel(_:sourceLocation:)`.
-->

### Annotate known issues
Expand Down