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

Add more documentation to BDD macros

Commit
9f44bd57f1c44e5dabc9825b06ee7c865e6253e6
Author
Martin Hořeňovský ·
Parents
6734c0aa643a

Files · Download .tar.gz

Changes

 docs/test-cases-and-sections.md | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md
index 4899af0e..48be68dc 100644
--- a/docs/test-cases-and-sections.md
+++ b/docs/test-cases-and-sections.md
@@ -132,8 +132,21 @@ SCENARIO( "vector can be sized and resized" ) {
     }
 }
 ```
-See [this working example](https://godbolt.org/z/e5vPPM), with an intentional failure to demonstrate the reporting 
-output.
+
+This code will result in two runs through the scenario:
+```
+Scenario : vector can be sized and resized
+  Given  : An empty vector
+  Then   : The size and capacity start at 0
+
+Scenario : vector can be sized and resized
+  Given  : An empty vector
+  When   : push_back() is called
+  Then   : The size changes
+```
+
+See also [runnable example on godbolt](https://godbolt.org/z/e5vPPM),
+with a more complicated (and failing) example.
 
 > `AND_GIVEN` was [introduced](https://github.com/catchorg/Catch2/issues/1360) in Catch2 2.4.0.