Skip to content

Commit 1ded6b3

Browse files
authored
doc(README): restructure test definition steps
1 parent 31e4d9b commit 1ded6b3

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@ via Julienne's `string_t` derived type. The target strings include command-line
66
via Julienne's `command_line_t` type and format strings generated by functions in Julienne's `formats_m` module.
77

88
Users construct tests by
9-
* Extending Julienne's `test_t` abstract derived type,
10-
* Constructing an array of `test_description_t` objects, each of which encapsulates
11-
* A string describing what functionality is being tested and
12-
* The name of a function that performs a test and produces one or more `test_diagnosis_t` result objects, each of which encapsulates
13-
* A `logical` indicator of the test outcome (`.true.` denotes a pass) and
14-
* A `character` or `string_t` diagnostics string.
9+
1. Extending Julienne's `test_t` abstract derived type,
10+
2. Defining a `subject()` function that returns a description of the entity being tested,
11+
3. Defining a `results()` function that
12+
- Constructs an array of `test_description_t` objects, each of which encapsulates
13+
* A string describing a function that produces one or more `test_diagnosis_t` result objects, each of which encapsulates
14+
* A `logical` indicator of whether the test passed and
15+
* A `character` or `string_t` diagnostics string.
16+
* The corresponding function name and
17+
- Produces an array of `test_result_t` objects.
18+
1519

1620
Julienne empowers users to customize the diagnostic information that prints when tests fail.
1721
For this purpose, Julienne's `string_t` constructors convert various data types, kinds, and ranks to character data.

0 commit comments

Comments
 (0)