From f69f821853d31a6c6e47e5e5717a03bd0236c567 Mon Sep 17 00:00:00 2001 From: Phil Nash Date: Mon, 13 Mar 2017 19:35:17 +0000 Subject: [PATCH] Updatecd [!shouldFail] docs with extra explanatory note, --- docs/test-cases-and-sections.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index 809935b6..2a14e86e 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -38,10 +38,10 @@ All tag names beginning with non-alphanumeric characters are reserved by Catch. * `[!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`. -* `[!shouldfail]` - reverse the failing logic of the test: if the test is successful if it fails, and vice-versa. - * `[!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. +* `[!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. + * `[!nonportable]` - Indicates that behaviour may vary between platforms or compilers. * `[#]` - 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]`.