Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Fixup shard index docs

Closes #2547
Commit
d8619f076b210a1ed5b5fea6e28a9ebf1e528557
Author
Martin Hořeňovský ·
Parents
95cd95e59169

Files · Download .tar.gz

Changes

 docs/command-line.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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).