Skip to content

Commit dd02f41

Browse files
authored
doc(README.md): describe unit testing framework
1 parent 0729097 commit dd02f41

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,16 @@ Contents
5151
* Input/output format strings and format string generators
5252

5353
### Classes
54+
* A command-line abstraction that searches for program arguments.
55+
* A minimalistic unit testing framework based around four types (see [./test/main.f90](./test/main.f90) for a use case):
56+
- `test_t` is a parent type to extend when defining unit tests,
57+
- `test_description_t` encapsulates scalar test functions and test descriptoins,
58+
- `vector_test_description`: encapsulates array-valued test functions and test descriptions.
59+
- `test_result_t` encapsulates test deescriptions and boolean (pass/fail) outcomes, and
5460
* Parallel data partitioning and gathering,
55-
* A minimalistic unit testing framework based around three types: `test_t`, `test_description_t`, and `test_result_t`
5661
* (Co-)[Object pattern] abstract parent,
5762
* Runtime units tracking,
5863
* A test oracle using the [Template Method pattern], and
59-
* A command-line abstraction that searches for program arguments.
6064

6165
Documentation
6266
-------------

0 commit comments

Comments
 (0)