Skip to content

Commit c7d3dda

Browse files
medreisbachchuckdudestmontgomerygrynspan
authored
Updates to Documentation.md to conform style (#342)
Update topic section names. Adding symbols alongside top level articles under topic groups. Part 1 of changes for rdar://119702877 ### 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. --------- Co-authored-by: Chuck Toporek <[email protected]> Co-authored-by: Stuart Montgomery <[email protected]> Co-authored-by: Jonathan Grynspan <[email protected]>
1 parent 19a6e11 commit c7d3dda

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

Sources/Testing/Testing.docc/Documentation.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,37 @@ concurrency, and parameterize test functions across wide ranges of inputs.
3737

3838
## Topics
3939

40-
### Getting started
40+
### Essentials
4141

4242
- <doc:TemporaryGettingStarted>
43-
- <doc:MigratingFromXCTest>
44-
45-
### Defining tests
46-
4743
- <doc:DefiningTests>
4844
- <doc:OrganizingTests>
45+
- ``Test(_:_:)``
46+
- ``Test``
47+
- ``Suite(_:_:)``
48+
49+
### Test parameterization
50+
4951
- <doc:ParameterizedTesting>
52+
- ``Test(_:_:arguments:)-8kn7a`` <!-- @attached(peer) macro Test<C>(_ displayName: String? = nil, _ traits: any TestTrait..., arguments collection: C) where C : Collection, C : Sendable, C.Element : Sendable -->
53+
- ``Test(_:_:arguments:_:)``
54+
- ``Test(_:_:arguments:)-3rzok`` <!-- @attached(peer) macro Test<C1, C2>(_ displayName: String? = nil, _ traits: any TestTrait..., arguments zippedCollections: Zip2Sequence<C1, C2>) where C1 : Collection, C1 : Sendable, C2 : Collection, C2 : Sendable, C1.Element : Sendable, C2.Element : Sendable -->
55+
- ``CustomTestArgumentEncodable``
56+
- ``Test/Parameter``
57+
- ``Test/Case``
5058

51-
### Validating behavior and raising issues
59+
### Behavior validation
5260

5361
- <doc:Expectations>
5462

55-
### Customizing tests
63+
### Test customization
5664

5765
- <doc:Traits>
66+
67+
### Migration
68+
69+
- <doc:MigratingFromXCTest>
70+
71+
### Extended modules
72+
73+
- ``Swift``

0 commit comments

Comments
 (0)