diff options
| -rw-r--r-- | tests/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md index e7713eed..d21784b6 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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. |