Skip to content

Commit 3c8e4e8

Browse files
authored
Clarify the number of supported argument collections in article which discusses combinatoric parameterized testing (#1210)
This is a small adjustment to the documentation article [Implementing parameterized tests](https://swiftpackageindex.com/swiftlang/swift-testing/main/documentation/testing/parameterizedtesting), in the section [Test with more than one collection](https://swiftpackageindex.com/swiftlang/swift-testing/main/documentation/testing/parameterizedtesting#Test-with-more-than-one-collection). It currently has a sentence which ends: > …, elements from the second collection are passed as the second argument, **and so forth.** The "and so forth" has caused some confusion since it implies that you can pass more than two argument collections, but in reality only two are supported currently. Eventually this could potentially be expanded with further improvements to the testing library, but that is tracked separately and the docs should reflect its current capabilities. Fixes rdar://154647425 ### 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 404b142 commit 3c8e4e8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Sources/Testing/Testing.docc/ParameterizedTesting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ func makeLargeOrder(of food: Food, count: Int) async throws {
146146
```
147147

148148
Elements from the first collection are passed as the first argument to the test
149-
function, elements from the second collection are passed as the second argument,
150-
and so forth.
149+
function, and elements from the second collection are passed as the second
150+
argument.
151151

152152
Assuming there are five cases in the `Food` enumeration, this test function
153153
will, when run, be invoked 500 times (5 x 100) with every possible combination

0 commit comments

Comments
 (0)