Skip to content

docs: use better mocha function types #2925

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

atjn
Copy link

@atjn atjn commented Apr 6, 2025

If you use arrow functions, you cannot use mocha features like timeout and skip. The docs make it clear that they're not recommended: https://mochajs.org/#arrow-functions

Also the docs make it clear that you can use async functions in it to support async operations, but cannot do so in describe: https://mochajs.org/#using-async-await

A 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

Copy link

changeset-bot bot commented Apr 6, 2025

⚠️ No Changeset found

Latest commit: b18058f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant