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

Update explanation of REQUIRE_FALSE in docs/assertions.md

Commit
5cd8938905cfc86c1254272540bd4bbefdc3bd07
Author
Martin Hořeňovský ·
Parents
6a422bae0b42

Files · Download .tar.gz

Changes

 docs/assertions.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/docs/assertions.md b/docs/assertions.md
index 32b079ae..40faa5eb 100644
--- a/docs/assertions.md
+++ b/docs/assertions.md
@@ -3,6 +3,7 @@
 
 **Contents**<br>
 [Natural Expressions](#natural-expressions)<br>
+[Floating point comparisons](#floating-point-comparisons)<br>
 [Exceptions](#exceptions)<br>
 [Matcher expressions](#matcher-expressions)<br>
 [Thread Safety](#thread-safety)<br>
@@ -31,16 +32,26 @@ CHECK( thisReturnsTrue() );
 REQUIRE( i == 42 );
 ```
 
+Expressions prefixed with `!` cannot be decomposed. If you have a type
+that is convertible to bool and you want to assert that it evaluates to
+false, use the two forms below:
+
+
 * **REQUIRE_FALSE(** _expression_ **)** and
 * **CHECK_FALSE(** _expression_ **)**
 
-Evaluates the expression and records the _logical NOT_ of the result. If an exception is thrown it is caught, reported, and counted as a failure.
-(these forms exist as a workaround for the fact that `!` prefixed expressions cannot be decomposed).
+Note that there is no reason to use these forms for plain bool variables,
+because there is no added value in decomposing them.
 
 Example:
+```cpp
+Status ret = someFunction();
+REQUIRE_FALSE(ret); // ret must evaluate to false, and Catch2 will print
+                    // out the value of ret if possibly
 ```
-REQUIRE_FALSE( thisReturnsFalse() );
-```
+
+
+### Other limitations
 
 Note that expressions containing either of the binary logical operators,
 `&&` or `||`, cannot be decomposed and will not compile. The reason behind
@@ -69,7 +80,7 @@ options.
    your tests.
 
 
-### Floating point comparisons
+## Floating point comparisons
 
 Comparing floating point numbers is complex, and [so it has its own
 documentation page](comparing-floating-point-numbers.md#top).