Skip to content

Commit

Permalink
tests: Add is_slow parameter to README
Browse files Browse the repository at this point in the history
  • Loading branch information
kjarosh committed Apr 11, 2024
1 parent 3dff1bc commit 0b31a73
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ ignore = false # If true, ignore this test. Please comment why, ideally link to
known_failure = false # If true, this test is known to fail and the result will be inverted. When the test passes in the future, it'll fail and alert that it now passes.
output_path = "output.txt" # Path (relative to the directory containing test.toml) to the expected output
log_fetch = false # If true, all network requests will be included in the output.
is_slow = false # If true, the test is marked as taking significantly longer to execute compared to others. Used for improving performance of the test suite.

# Sometimes floating point math doesn't exactly 100% match between flash and rust.
# If you encounter this in a test, the following section will change the output testing from "exact" to "approximate"
Expand Down Expand Up @@ -71,4 +72,4 @@ sleep_to_meet_frame_rate = false # If true, slow the tick rate to match the movi

`fscommand("quit")` is enabled for tests, and will end the test at the end of this frame or tick.

You can use this to end a test prematurely before the set number of iterations elapses, which may be useful for timer tests.
You can use this to end a test prematurely before the set number of iterations elapses, which may be useful for timer tests.

0 comments on commit 0b31a73

Please sign in to comment.