Skip to content

Commit ae900b1

Browse files
authored
Enable the Docs soundness check (#1314)
Enable the (currently-disabled) Docs soundness check via GitHub Actions. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
1 parent 2e4f1a5 commit ae900b1

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

.github/workflows/pull_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ jobs:
2424
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
2525
with:
2626
license_header_check_project_name: "Swift"
27-
docs_check_enabled: false
27+
docs_check_container_image: "swift:6.2-noble"
2828
format_check_enabled: false
2929
api_breakage_check_enabled: false

Sources/Testing/Testing.docc/Documentation.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ their problems.
3535

3636
#### Related videos
3737

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

4341
## Topics
4442

Sources/Testing/Testing.docc/MigratingFromXCTest.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -556,9 +556,11 @@ test function with an instance of this trait type to control whether it runs:
556556
}
557557
}
558558

559-
<!-- TODO: document Test.cancel() and Test.Case.cancel() here
559+
<!-- TODO: document Test.cancel() and Test.Case.cancel() here, and update
560+
relevant links to use proper DocC symbol references.
561+
560562
If a test has already started running and you determine it cannot complete and
561-
should end early without failing, use ``Test/cancel(_:sourceLocation:)`` instead
563+
should end early without failing, use `Test/cancel(_:sourceLocation:)` instead
562564
of [`XCTSkip`](https://developer.apple.com/documentation/xctest/xctskip) to
563565
cancel the task associated with the current test:
564566
@@ -592,7 +594,7 @@ cancel the task associated with the current test:
592594
}
593595
594596
If the test is parameterized and you only want to cancel the current test case
595-
rather than the entire test, use ``Test/Case/cancel(_:sourceLocation:)``.
597+
rather than the entire test, use `Test/Case/cancel(_:sourceLocation:)`.
596598
-->
597599

598600
### Annotate known issues

0 commit comments

Comments
 (0)