docs: use better mocha function types #2925
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If you use arrow functions, you cannot use mocha features like
timeout
andskip
. The docs make it clear that they're not recommended: https://mochajs.org/#arrow-functionsAlso the docs make it clear that you can use async functions in
it
to support async operations, but cannot do so indescribe
: https://mochajs.org/#using-async-awaitA lot of people copy the example code and work from there. By using the correct function declarations and including async, you make it a lot easier to get started without encountering weird bugs or having to read a lot of mocha documentation.
Sister PR: #2924