3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve formatting of test specification docs 

The existing formatting created one-element lists separated by paragraphs, when it would make more sense to have the paragraphs that are providing more information about one of those list entries be part of the list entry itself.

I think this makes the documentation easier to read in both markdown and html form, and should also improve the structure for assistive technologies.
This commit is contained in:
Alex Merry 2023-10-23 16:14:15 +01:00 committed by Martin Hořeňovský
parent 766541d12d
commit 966d361551
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/command-line.md
View File

@ -95,46 +95,46 @@ complex specs:
* Full test name, e.g. `"Test 1"`. * Full test name, e.g. `"Test 1"`.
This allows only test cases whose name is "Test 1". This allows only test cases whose name is "Test 1".
* Wildcarded test name, e.g. `"*Test"`, or `"Test*"`, or `"*Test*"`. * Wildcarded test name, e.g. `"*Test"`, or `"Test*"`, or `"*Test*"`.
This allows any test case whose name ends with, starts with, or contains This allows any test case whose name ends with, starts with, or contains
in the middle the string "Test". Note that the wildcard can only be at in the middle the string "Test". Note that the wildcard can only be at
the start or end. the start or end.
* Tag name, e.g. `[some-tag]`. * Tag name, e.g. `[some-tag]`.
This allows any test case tagged with "[some-tag]". Remember that some This allows any test case tagged with "[some-tag]". Remember that some
tags are special, e.g. those that start with "." or with "!". tags are special, e.g. those that start with "." or with "!".
You can also combine the basic test specs to create more complex test You can also combine the basic test specs to create more complex test
specs. You can specs. You can:
* Concatenate specs to apply all of them, e.g. `[some-tag][other-tag]`. * Concatenate specs to apply all of them, e.g. `[some-tag][other-tag]`.
This allows test cases that are tagged with **both** "[some-tag]" **and** This allows test cases that are tagged with **both** "[some-tag]" **and**
"[other-tag]". A test case with just "[some-tag]" will not pass the filter, "[other-tag]". A test case with just "[some-tag]" will not pass the filter,
nor will test case with just "[other-tag]". nor will test case with just "[other-tag]".
* Comma-join specs to apply any of them, e.g. `[some-tag],[other-tag]`. * Comma-join specs to apply any of them, e.g. `[some-tag],[other-tag]`.
This allows test cases that are tagged with **either** "[some-tag]" **or** This allows test cases that are tagged with **either** "[some-tag]" **or**
"[other-tag]". A test case with both will obviously also pass the filter. "[other-tag]". A test case with both will obviously also pass the filter.
Note that commas take precendence over simple concatenation. This means Note that commas take precendence over simple concatenation. This means
that `[a][b],[c]` accepts tests that are tagged with either both "[a]" and that `[a][b],[c]` accepts tests that are tagged with either both "[a]" and
"[b]", or tests that are tagged with just "[c]". "[b]", or tests that are tagged with just "[c]".
* Negate the spec by prepending it with `~`, e.g. `~[some-tag]`. * Negate the spec by prepending it with `~`, e.g. `~[some-tag]`.
This rejects any test case that is tagged with "[some-tag]". Note that This rejects any test case that is tagged with "[some-tag]". Note that
rejection takes precedence over other filters. rejection takes precedence over other filters.
Note that negations always binds to the following _basic_ test spec. Note that negations always binds to the following _basic_ test spec.
This means that `~[foo][bar]` negates only the "[foo]" tag and not the This means that `~[foo][bar]` negates only the "[foo]" tag and not the
"[bar]" tag. "[bar]" tag.
Note that when Catch2 is deciding whether to include a test, first it Note that when Catch2 is deciding whether to include a test, first it
checks whether the test matches any negative filters. If it does, checks whether the test matches any negative filters. If it does,