berkus
/
kdl
mirror of https://github.com/kdl-org/kdl.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add a note about what to do if a test fails (or wrongly succeeds)

This commit is contained in:
Kat Marchán 2021-08-31 22:31:16 -07:00
parent fd478c29c7
commit 83c24e48a4
No known key found for this signature in database
GPG Key ID: AEB529C08A3C7E9E
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tests/README.md
View File

@ -6,6 +6,8 @@ output after being run through the parser and printed out again. If there's no
file in `expected_kdl` with a name corresponding to one in `input` it file in `expected_kdl` with a name corresponding to one in `input` it
indicates that parsing for that case should fail. indicates that parsing for that case should fail.
## Translation Rules
By necessity, the files in `expected_kdl` are not identical to their By necessity, the files in `expected_kdl` are not identical to their
corresponding inputs. They are instead pretty-printed according to the corresponding inputs. They are instead pretty-printed according to the
following rules: following rules:
@ -34,3 +36,17 @@ following rules:
Data may be manipulated as you wish in order to output the expected KDL. This Data may be manipulated as you wish in order to output the expected KDL. This
test suite verifies the ability to **parse**, not specific quirks about test suite verifies the ability to **parse**, not specific quirks about
internal representations. internal representations.
## What to do if a test fails for you
This test suite was originally designed for a pre-1.0 version of the KDL
specification. If you encounter a failure, it's likely that the test suite
will need to be updated, rather than your parser itself. This test suite is
NOT AUTHORITATIVE. If this test suite disagrees with the KDL spec in any way,
the most desirable resolution is to send a PR to this repository to fix the
test itself. Likewise, if you think a test succeeded but should not have,
please send a PR.
If you think the disagreement is due to a genuine error or oversight in the
KDL specification, please open an issue explaining the matter and the change
will be considered for the next version of the KDL spec.