Skip to content

Commit

Permalink
update slow description (#3466)
Browse files Browse the repository at this point in the history
Update mocha doc to have more details on the "slow" configuration
  • Loading branch information
finfin authored and boneskull committed Dec 4, 2018
1 parent 41f9d56 commit b636faf
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
Binary file added docs/images/test-duration-range.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion docs/index.md
Expand Up @@ -707,10 +707,18 @@ $ mocha

<h2 id="test-duration">Test duration</h2>

Many reporters will display test duration, as well as flagging tests that are slow, as shown here with the "spec" reporter:
Many reporters will display test duration and flag tests that are slow (default: 75ms), as shown here with the "spec" reporter:

![test duration](images/reporter-spec-duration.png?withoutEnlargement&resize=920,9999){:class="screenshot"}

There are three levels of test duration (depicted in the following image):

1. FAST: Tests that run within half of the "slow" threshold will show the duration in green (if at all).
2. NORMAL: Tests that run exceeding half of the threshold (but still within it) will show the duration in yellow.
3. SLOW: Tests that run exceeding the threshold will show the duration in red.

![test duration range](images/test-duration-range.png?withoutEnlargement&resize=920,9999){:class="screenshot"}

To tweak what's considered "slow", you can use the `slow()` method:

```js
Expand Down

0 comments on commit b636faf

Please sign in to comment.