Skip to content

Commit 8a3379a

Browse files
committed
doc(vector_test_description): rm all references
1 parent 0fd7b73 commit 8a3379a

3 files changed

Lines changed: 3 additions & 40 deletions

File tree

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -251,12 +251,10 @@ GCC `gfortran` | 13, 14, 15 | see 1 below
251251
Intel `ifx` | 2025.1.1 Build 20250418 | see 2 below
252252

253253
1. `gfortran` issues:
254-
- With GCC 14 or earlier, the `test_description_t` constructor's
254+
- With GCC 14.2.0 or earlier, the `test_description_t` constructor's
255255
`diagnosis_function` actual argument must be a procedure pointer conforming
256256
conforming with the `diagnosis_function_i` abstract interface.
257-
- The `string_t` `bracket` type-bound function crashes for GCC 14 or earlier.
258-
- _Deprecated feature_: Each element of a [`vector_test_description_t`] array
259-
must be defined in a separate statement.
257+
- The `string_t` `bracket` type-bound function crashes for GCC 14.2.0 or earlier.
260258
2. `ifx` issue:
261259
- Two `string_t` tests fail as described in issue [#51].
262260

@@ -317,5 +315,4 @@ See our online [documentation] or build the documentation locally by installing
317315
[Garden]: https://gitlab.com/everythingfunctional/garden
318316
[handy-dandy]: https://github.com/rouson/handy-dandy/blob/7caaa4dc3d6e5331914a3025f0cb1db5ac1a886f/src/fresh-llvm-build.sh
319317
[Sourcery]: https://github.com/sourceryinstitute/sourcery
320-
[`vector_test_diagnosis_i`]: https://github.com/BerkeleyLab/julienne/blob/37bcc959efa8f9e27ae50fecfd37a6bf52ef0a43/src/julienne/julienne_vector_test_description_m.F90#L18
321318
[Veggies]: https://gitlab.com/everythingfunctional/veggies

demo/README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Skipping Tests
115115
--------------
116116
When a test is known to cause a compile-time or runtime crash in a specific scenario, e.g., with a specific compiler or compiler version, including that test will prevent the test suite from building or running to completion.
117117
It can be useful to skip a test with the problematic compiler but to report the test as skipped and account for the skipped tests in the tally of test results.
118-
For this purpose, the `test_description_t` and `vector_test_description_t` constructor functions have optional second arguments `diagnosis_function` and `vector_diagnosis_function`, respectively.
118+
For this purpose, the `test_description_t` constructor function has a `diagnosis_function` argument that is optional.
119119
When these arguments are not `present`, the `test_t`'s `report` procedure will report the test as skipped but will terminate normally as long as the sum of the passing tests and skipped tests equals the total number of tests.
120120
One might accomplish this with the compiler's predefined preprocessor macro:
121121
```
@@ -159,29 +159,3 @@ class string_t{
159159
base_name(string_t) string_t
160160
}
161161
```
162-
163-
Deprecated: Vector Diagnosis Function
164-
-------------------------------------
165-
Julienne's `vector_diagnosis_function_i` abstract interface and the corresponding `vector_test_description_t` type were developed before Julienne's `operator(.all.)` and `operator(.and.)`.
166-
Because the operators replace the interface and type with simpler functionality, it is likely that a future release will remove the `vector_*` entities.
167-
168-
The Unified Modeling Language ([UML](https://wikipedia.org/Unified_modeling_language)) class diagram below depicts the class relationships involved when test function performs multiple checks and defines a result containing an array of corresponding `test_diagnosis_t` objects:
169-
```mermaid
170-
%%{init: { 'theme':'default', "class" : {"hideEmptyMembersBox": true} } }%%
171-
classDiagram
172-
173-
class vector_test_description_t{
174-
vector_test_description_t(description : string_t[1..*], vector_diagnosis_function : vector_diagnosis_function_i)
175-
run() test_result_t[1..*]
176-
}
177-
vector_test_description_t --> test_diagnosis_t : run() invokes vector_diagnosis_function to construct array of
178-
vector_test_description_t --> test_result_t : run() uses test_diagnostics_t array to construct array of
179-
180-
class test_result_t{
181-
test_result_t(test_passed : logical, diagnosis : test_diagnosis_t)
182-
}
183-
184-
class test_diagnosis_t{
185-
test_diagnosis_t(test_passed : logical, diagnostics_string : string_t)
186-
}
187-
```

doc/uml/class-diagram.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ classDiagram
55
66
test_t --> test_result_t : produces
77
test_description_t --> test_diagnosis_t : "'run' uses to construct test_result_t"
8-
vector_test_description_t --> test_diagnosis_t : "'run' uses to construct test_result_t array"
98
test_result_t --> test_diagnosis_t : "accepts as constructor argument"
109
1110
class test_t{
@@ -54,10 +53,3 @@ class test_description_t{
5453
+ contains_text(string_t) logical
5554
+ operator(==) logical
5655
}
57-
58-
class vector_test_description_t{
59-
+ vector_test_description_t(description : string_t, vector_diagnosis_function : procedure(vector_diagnosis_function_i)) test_description_t
60-
+ run() test_result_t
61-
+ contains_text(character) logical
62-
+ contains_text(string_t) logical
63-
}

0 commit comments

Comments
 (0)