Skip to content

Commit

Permalink
Explicitly mark "Timeouts in Tests" as deprecated
Browse files Browse the repository at this point in the history
Related to #11029
  • Loading branch information
Hexcles authored May 16, 2018
1 parent a0bd72d commit 27c029b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/_writing-tests/testharness-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,14 +318,14 @@ the test result is known. For example:
}, "Calling document.getElementById with a null argument.");
```

## Timeouts in Tests ##
## DEPRECATED Timeouts in Tests ##

In general the use of timeouts in tests is discouraged because this is
an observed source of instability in real tests when run on CI
infrastructure. In particular if a test should fail when something
doesn't happen, it is good practice to simply let the test run to the
full timeout rather than trying to guess an appropriate shorter
timeout to use.
timeout to use. Please use harness timeout instead.

In other cases it may be necessary to use a timeout (e.g., for a test
that only passes if some event is *not* fired). In this case it is
Expand Down

0 comments on commit 27c029b

Please sign in to comment.