Skip to content

Commit a36bbe0

Browse files
authored
Updating documentation overview and availability info (#484)
### 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 00a3a94 commit a36bbe0

File tree

2 files changed

+41
-18
lines changed

2 files changed

+41
-18
lines changed

Sources/Testing/Testing.docc/Documentation.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,29 @@ Create and run tests for your Swift packages and Xcode projects.
1616

1717
## Overview
1818

19-
`swift-testing` is a modern, open-source testing library for Swift with powerful
20-
and expressive capabilities. It gives developers more confidence with less code.
21-
22-
### Flexible test organization
23-
24-
Define test functions almost anywhere with a single attribute and group related
25-
tests into hierarchies using Swift's type system.
26-
27-
### Customizable metadata
28-
29-
Dynamically enable or disable tests depending on runtime conditions, categorize
30-
tests using tags, and associate bugs directly with the tests that verify their
31-
fixes or reproduce their problems.
32-
33-
### Scalable execution
34-
35-
Automatically parallelize tests in-process, integrate seamlessly with Swift
36-
concurrency, and parameterize test functions across wide ranges of inputs.
19+
With Swift Testing you leverage powerful and expressive capabilities of
20+
the Swift programming language to develop tests with more confidence and less
21+
code. The library integrates seamlessly with Swift Package Manager testing
22+
workflow, supports flexible test organization, customizable metadata, and
23+
scalable test execution.
24+
25+
- Define test functions almost anywhere with a single attribute.
26+
- Group related tests into hierarchies using Swift's type system.
27+
- Integrate seamlessly with Swift concurrency.
28+
- Parameterize test functions across wide ranges of inputs.
29+
- Enable tests dynamically depending
30+
on runtime conditions.
31+
- Parallelize tests in-process.
32+
- Categorize tests using tags.
33+
- Associate bugs directly with the tests that verify their fixes or reproduce
34+
their problems.
35+
36+
#### Related videos
37+
38+
@Links(visualStyle: compactGrid) {
39+
- <doc://com.apple.documentation/videos/play/wwdc2024/10179>
40+
- <doc://com.apple.documentation/videos/play/wwdc2024/10195>
41+
}
3742

3843
## Topics
3944

Sources/Testing/Testing.docc/Info.plist

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,23 @@
2020
<string>0.1.0</string>
2121
<key>CFBundleVersion</key>
2222
<string>0.1.0</string>
23+
<key>CDAppleDefaultAvailability</key>
24+
<dict>
25+
<key>Testing</key>
26+
<array>
27+
<dict>
28+
<key>name</key>
29+
<string>Xcode</string>
30+
<key>version</key>
31+
<string>16.0</string>
32+
</dict>
33+
<dict>
34+
<key>name</key>
35+
<string>Swift</string>
36+
<key>version</key>
37+
<string>6.0</string>
38+
</dict>
39+
</array>
40+
</dict>
2341
</dict>
2442
</plist>

0 commit comments

Comments
 (0)