migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-09-02 23:00:04 -04:00
Code Activity

Some minor docs improvements (#7614)

Browse Source
This commit is contained in:
Lucas Meurer
2025-10-09 12:00:39 +02:00
committed by GitHub
parent cfca7ebd6d
commit da39198142
5 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
crates/egui_kittest/README.md
View File

@@ -50,8 +50,8 @@ This is so that you can set `UPDATE_SNAPSHOTS=true` and update all tests, withou
If you want to update all snapshot images, even those that are within error margins,
run with `UPDATE_SNAPSHOTS=force`.
If you want to have multiple snapshots in the same test, it makes sense to collect the results in a `Vec`
([look here](https://github.com/emilk/egui/blob/70a01138b77f9c5724a35a6ef750b9ae1ab9f2dc/crates/egui_demo_lib/src/demo/demo_app_windows.rs#L388-L427) for an example).
If you want to have multiple snapshots in the same test, it makes sense to collect the results in a `SnapshotResults`
([look here](https://github.com/emilk/egui/blob/d1fcd740ded5d69016c993a502b52e67f5d492d7/crates/egui_demo_lib/src/demo/demo_app_windows.rs#L387-L420) for an example).
This way they can all be updated at the same time.
You should add the following to your `.gitignore`:
@@ -67,7 +67,7 @@ You should add the following to your `.gitignore`:
* …they are brittle since unrelated side effects (like a change in color) can cause the test to fail
* …images take up repo space
* images should…
* …be checked in or otherwise be available (egui use [git LFS](https://git-lfs.com/) files for this purpose)
* …be checked in or otherwise be available (egui uses [git LFS](https://git-lfs.com/) files for this purpose)
* …depict exactly what's tested and nothing else
* …have a low resolution to avoid growth in repo size
* …have a low comparison threshold to avoid the test passing despite unwanted differences (the default threshold should be fine for most usecases!)