caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-20 03:55:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Connect maximum size with Updating reference images (#5022)

Browse Source
This commit is contained in:
Josh Soref 2024-09-26 04:40:15 -04:00 committed by GitHub
parent 30a301f8ff
commit 7d2142be0a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tests/README.md
View File

@ -87,6 +87,8 @@ There are, broadly speaking, three kinds of tests:
To prevent bloat, it is important that the test images are kept as small as
possible. To that effect, the test runner enforces a maximum size of 20 KiB.
If you're updating a test and hit `reference image size exceeds`, see
Updating reference images.
If truly necessary, this limit can however be lifted by adding `// LARGE` as
the first line of a test.
@ -102,6 +104,9 @@ flag:
testit --exact my-test-name --update
```
This will generally generate compressed reference images (to remain within the
above size limit).
If you use the VS Code test helper extension (see the `tools` folder), you can
alternatively use the save button to update the reference image.