Skip to content

Commit f8db2f5

Browse files
committed
doc(README): improve language and structure
1 parent 9e36d33 commit f8db2f5

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
Julienne
2-
========
31
```
42
_ _ _
53
| |_ _| (_) ___ _ __ _ __ ___
64
_ | | | | | | |/ _ \ '_ \| '_ \ / _ \
75
| |_| | |_| | | | __/ | | | | | | __/
86
\___/ \__,_|_|_|\___|_| |_|_| |_|\___|
97
```
8+
Julienne
9+
========
1010
Julienne is a modern Fortran unit-testing framework that includes utilities for manipulating strings
1111
via Julienne's `string_t` derived type. The target strings include command-line arguments accessed
1212
via Julienne's `command_line_t` type and format strings generated by functions in Julienne's `formats_m` module.
@@ -15,20 +15,20 @@ Users construct tests by
1515
1. Extending Julienne's `test_t` abstract derived type,
1616
2. Defining a `subject()` function that returns a description of the entity being tested,
1717
3. Defining a `results()` function that
18-
- Constructs an array of `test_description_t` objects, each of which encapsulates
18+
- Defines a result comprised of an array of `test_result_t` objects.
19+
- Constructs a local array of `test_description_t` objects, each of which encapsulates
1920
* A string describing a function that produces one or more `test_diagnosis_t` result objects, each of which encapsulates
2021
* A `logical` indicator of whether the test passed and
2122
* A `character` or `string_t` diagnostics string.
2223
* The corresponding function name and
23-
- Produces an array of `test_result_t` objects.
2424

2525
Julienne empowers users to customize the diagnostic information that prints when tests fail.
2626
For this purpose, Julienne's `string_t` constructors convert various data types, kinds, and ranks to character data.
2727
Julienne also provides `string_t` operators supporting concatenation and delimited lists such as comma-separated value lists.
2828

2929
Julienne's name derives from the term for vegetables sliced into thin strings: julienned vegetables.
3030
The [Veggies] unit-testing framework inspired the structure of Julienne's tests and output.
31-
Julienne aims to be a more lightweight alternative that is more portable across compilers and compiler versions.
31+
Julienne aims to be a more lightweight alternative that is more portable across compilers.
3232

3333
Getting Started
3434
---------------

0 commit comments

Comments
 (0)