Skip to content
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

Documentation for 'no-async-tests' is misleading #96

Open
swinejelly opened this issue Mar 8, 2022 · 0 comments
Open

Documentation for 'no-async-tests' is misleading #96

swinejelly opened this issue Mar 8, 2022 · 0 comments
Labels

Comments

@swinejelly
Copy link

The documentation for 'no async tests', while I agree the rule itself is extremely important to avoid this issue, seems to be misstating what Cypress will do.

The existing documentation implies that the example, incorrect test cases will error and fail, while what will really happen is those test cases will succeed even if the Cypress assertions in them fail, which makes this lint rule extremely important (the former would force people to fix their test cases, the latter will lead to test cases succeeding even when they should be failing).

I suggest until cypress-io/cypress#4742 can be fixed that we update these docs to describe the actual behavior which will emphasize the importance of this rule.

If someone can confirm my understanding I may be able to make a PR for this change myself.

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

No branches or pull requests

2 participants