From ab713894cc26ace78067d8d494061dd9bd0e5ca8 Mon Sep 17 00:00:00 2001 From: Clare Macrae Date: Mon, 22 Jul 2019 13:08:38 +0100 Subject: [PATCH] Add docs for AND_GIVEN macro - see #1360 --- docs/test-cases-and-sections.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index 3545e76c..5f524320 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -84,10 +84,11 @@ This macro maps onto ```TEST_CASE``` and works in the same way, except that the These macros map onto ```SECTION```s except that the section names are the _something_s prefixed by "given: ", "when: " or "then: " respectively. +* **AND_GIVEN(** _something_ **)** * **AND_WHEN(** _something_ **)** * **AND_THEN(** _something_ **)** -Similar to ```WHEN``` and ```THEN``` except that the prefixes start with "and ". These are used to chain ```WHEN```s and ```THEN```s together. +Similar to ```GIVEN```, ```WHEN``` and ```THEN``` except that the prefixes start with "and ". These are used to chain ```GIVEN```s, ```WHEN```s and ```THEN```s together. When any of these macros are used the console reporter recognises them and formats the test case header such that the Givens, Whens and Thens are aligned to aid readability.