Skip to content

Commit f69f821

Browse files
committed
Updatecd [!shouldFail] docs with extra explanatory note,
1 parent 485dbdc commit f69f821

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/test-cases-and-sections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ All tag names beginning with non-alphanumeric characters are reserved by Catch.
3838

3939
* `[!throws]` - lets Catch know that this test is likely to throw an exception even if successful. This causes the test to be excluded when running with `-e` or `--nothrow`.
4040

41-
* `[!shouldfail]` - reverse the failing logic of the test: if the test is successful if it fails, and vice-versa.
42-
4341
* `[!mayfail]` - doesn't fail the test if any given assertion fails (but still reports it). This can be useful to flag a work-in-progress, or a known issue that you don't want to immediately fix but still want to track in the your tests.
4442

43+
* `[!shouldfail]` - like `[!mayfail]` but *fails* the test if it *passes*. This can be useful if you want to be notified of accidental, or third-party, fixes.
44+
4545
* `[!nonportable]` - Indicates that behaviour may vary between platforms or compilers.
4646

4747
* `[#<filename>]` - running with `-#` or `--filenames-as-tags` causes Catch to add the filename, prefixed with `#` (and with any extension stripped) as a tag. e.g. tests in testfile.cpp would all be tagged `[#testfile]`.

0 commit comments

Comments
 (0)