Explain the purpose of the benchmarks

This commit is contained in:
Tab Atkins-Bittner 2025-01-18 07:51:14 -08:00
parent bd30d4ffbc
commit 58ee3f0b31
1 changed files with 4 additions and 0 deletions

View File

@ -54,3 +54,7 @@ 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.
# Benchmarks
The `benchmarks` folder contains some large or gnarly documents intended to be used to stress-test your parser and help with profiling. They are intentionally not part of the testsuite, and just provided for your own personal benefit.