diff options
| author | Martin Hořeňovský | 2022-10-16 17:00:23 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2022-10-16 17:00:29 +0200 |
| commit | d8619f076b210a1ed5b5fea6e28a9ebf1e528557 (patch) | |
| tree | 0a94cc4c712aa74f0f81e5f7d0f5f3f863089dcd | |
| parent | 95cd95e591696bee5fbf24cf5b3a1610b4d05e3b (diff) | |
| download | catch3-d8619f076b210a1ed5b5fea6e28a9ebf1e528557.tar.gz | |
Fixup shard index docs
Closes #2547
| -rw-r--r-- | docs/command-line.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/command-line.md b/docs/command-line.md index 1bae481b..21a0da4c 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -548,7 +548,8 @@ starting at 0. The tests in the set given by `--shard-index <#shard index to run>` will be executed. The default shard count is `1`, and the default index to run is `0`. -_It is an error to specify a shard index greater than the number of shards._ +_Shard index must be less than number of shards. As the name suggests, +it is treated as an index of the shard to run._ Sharding is useful when you want to split test execution across multiple processes, as is done with the [Bazel test sharding](https://docs.bazel.build/versions/main/test-encyclopedia.html#test-sharding). |