From 9f44bd57f1c44e5dabc9825b06ee7c865e6253e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Tue, 23 Mar 2021 13:02:07 +0100 Subject: [PATCH] Add more documentation to BDD macros --- 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.