summaryrefslogtreecommitdiff
path: root/tests
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2024-10-03 15:20:48 +0200
committerGitHub <noreply@github.com>2024-10-03 13:20:48 +0000
commitcbd251f4749241bbf722fe538cb42dd6edef8c1c (patch)
treee58bf85b61ea90fde4b645a4acf93fe7631c9142 /tests
parent0343e038d373b9164679c4d7b2c5345c58c123b7 (diff)
Tweak docs (#5089)
Diffstat (limited to 'tests')
-rw-r--r--tests/README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/tests/README.md b/tests/README.md
index d21784b6..4f5a3169 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -87,10 +87,10 @@ 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.
+ If you're updating a test and hit `reference image size exceeds`, see the
+ section on "Updating reference images" below. If truly necessary, the size
+ limit can be lifted by adding `// LARGE` as the first line of a test, but this
+ should be the case very rarely.
If you have the choice between writing a test using assertions or using
reference images, prefer assertions. This makes the test easier to understand