Skip to content

Commit ac341e5

Browse files
committed
Adopt Nate's suggested phrasing for test filter interactions in README.md
1 parent 57e8225 commit ac341e5

1 file changed

Lines changed: 2 additions & 9 deletions

File tree

‎pkgs/test/README.md‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -227,15 +227,8 @@ can significantly reduce the overall testing time.
227227

228228
The sharding modes interact differently with filters like `--name` or `--tags`:
229229

230-
* When sharding by test (default), the sharding partition is calculated *after*
231-
applying filters. This guarantees that the matching tests are distributed
232-
as evenly as possible across all shards.
233-
* When sharding by suite (using `--shard-by-suite`), suite-level annotations
234-
(such as `@TestOn` platform selectors and suite-level `@Tags`) are evaluated
235-
before suite sharding, filtering out non-matching suites so shards do not receive
236-
empty workloads. In contrast, test-case/group filters (such as `--name` or test-level tags)
237-
operate on test cases within loaded suites after sharding. If a test-case filter only matches tests in a
238-
few suites, some shards might run no tests because those suites were allocated to other shards.
230+
* When sharding by test case (default), the partition is calculated *after* applying filters. This guarantees matching test cases are distributed as evenly as possible across all shards.
231+
* When sharding by test suite (using `--shard-by-suite`), suite-level annotations (such as `@TestOn` platform selectors and suite-level `@Tags` at the top of a file) are evaluated before sharding to filter out non-matching suites. However, test filters which apply to individual test cases or groups (such as `--name`) will be reflected in the distribution when sharding by test case, but not when sharding by test suite. Test invocations with an uneven number of matching test cases between test suites can cause uneven workloads across the shards.
239232

240233
### Test concurrency
241234

0 commit comments

Comments
 (0)