more doc formatting fixes

This commit is contained in:
Phil Nash
2013-10-02 08:17:46 +01:00
parent 0b097c26b6
commit 34266b6e0f
2 changed files with 28 additions and 23 deletions

View File

@@ -6,8 +6,8 @@ Instead Catch provides a powerful mechanism for nesting test case sections withi
Test cases and sections are very easy to use in practice:
**TEST_CASE(** _test name_ \[**,** _tags_ \] **)**
**SECTION(** _section name_ **)**
* **TEST_CASE(** _test name_ \[, _tags_ \] **)**
* **SECTION(** _section name_ **)**
_test name_ and _section name_ are free form, quoted, strings. The optional _tags_ argument is a quoted string containing one or more tags enclosed in square brackets. Tags are discussed below. Test names must be unique within the Catch executable.
@@ -21,18 +21,18 @@ For examples see the [Tutorial](tutorial.md)
In addition to Catch's take on the classic style of test cases, Catch supports an alternative syntax that allow tests to be written as "executable specifications" (one of the early goals of [Behaviour Driven Development](http://dannorth.net/introducing-bdd/)). This set of macros map on to ```TEST_CASE```s and ```SECTION```s, with a little internal support to make them smoother to work with.
**SCENARIO(** _scenario name_ \[**,** _tags_ \] **)**
* **SCENARIO(** _scenario name_ \[, _tags_ \] **)**
This macro maps onto ```TEST_CASE``` and works in the same way, except that the test case name will be prefixed by "Scenario: "
**GIVEN(** _something_ **)**
**WHEN(** _something_ **)**
**THEN(** _something_ **)**
* **GIVEN(** _something_ **)**
* **WHEN(** _something_ **)**
* **THEN(** _something_ **)**
These macros map onto ```SECTION```s except that the section names are the _something_s prefixed by "given: ", "when: " or "then: " respectively.
**AND_WHEN(** _something_ **)**
**AND_THEN(** _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.