Skip to content

Commit 725f595

Browse files
committed
Add basic docs to regressionfiles.yaml
1 parent 760efe7 commit 725f595

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

regressionfiles.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
# Each entry in the `regressions` list corresponds to a single regression test.
2+
# An entry may be parsed and/or tested.
3+
# The keys in each entry are:
4+
#
5+
# - loc_entry (required str): A path relative to this file pointing to
6+
# a single output file or a directory where all files it contains
7+
# should be read (such as for Turbomole).
8+
#
9+
# - tests (optional list of str, default empty): Names of test classes (not functions)
10+
# to run the entry through.
11+
#
12+
# - parse (optional bool, default true): Should this entry be parsed?
13+
# Usually used in conjunction with writing a `testnoparse` function that
14+
# uses the `logfile` fixture.
115
regressions:
216
- loc_entry: ADF/ADF2004.01/Au2-fixed.adfout
317
- loc_entry: ADF/ADF2004.01/Fe-ox3-final.out

0 commit comments

Comments
 (0)