Skip to content

Commit a3d9df3

Browse files
authored
Merge pull request #82 from sourceryinstitute/update-readme
doc(README.md): describe unit testing framework
2 parents 0729097 + fe768e8 commit a3d9df3

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
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
-------------

fpm.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name = "sourcery"
2-
version = "4.7.1"
2+
version = "4.8.0"
33
license = "BSD"
44
author = ["Damian Rouson"]
55
maintainer = "[email protected]"

0 commit comments

Comments
 (0)