Documentation - Githubissues

tingerrr / typst-test

A test runner for typst projects.

https://tingerrr.github.io/typst-test/

MIT License

27 stars 2 forks source link

Documentation #30

Open tingerrr opened 4 months ago

tingerrr commented 4 months ago

A lot of things are only partially documented:

the test set language is unfinished and only has a single example
the folder structure of tests is not documented anywhere
the kinds of tests which are supported and how they interact with various cli arguments
test annotations
the meaning of cli test comparison parameters (max-deviation and max-delta)
the additional testing utilities provided to test scripts

All of these and more need to be crystal clear and well explained before a release is possible.