Skip to content
This repository was archived by the owner on Apr 8, 2024. It is now read-only.

Commit f89605c

Browse files
authored
Merge pull request #34 from CAD97/test-guarantees
"complete"ness clarification
2 parents 5dc4ad9 + a93de1b commit f89605c

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,20 @@ produce is tracked in [src/bin/snapshots](src/bin/snapshots). The tests are run
4646

4747
cargo run --bin snapshots --release
4848

49-
A list of the tested productions is maintained in the test dispatcher,
50-
[snapshots.rs](src/bin/snapshots.rs). These tested productions are,
51-
to the best of the maintainers' ability, to be considered "complete"
52-
in terms of their structure, though the ability to remove trees from
53-
ambiguous forests is explicitly reserved (even when tested).
49+
Once a snapshot is present for a given production, that production is,
50+
to the best of the maintainers' ability, considered "complete"
51+
in terms of its structure.
52+
53+
Note, however, that this is a shallow and non-transitive property:
54+
if e.g. `Expr` is tested, the structural completeness extends only
55+
to `Expr` itself and not to `OuterAttr` nor `ExprKind`.
56+
57+
A test may also have the name `<production>.<variant>.<test-name>.input`,
58+
in which case only that variant should be considered tested and marked
59+
"complete" by that test case.
60+
61+
At all times we reserve the right to change parse forests that do not produce
62+
unique parse trees, and to disambiguate tested parse forests to a subset.
5463

5564
## Links
5665

0 commit comments

Comments
 (0)