docs: Add sync-only info to expect.toThrowError TIP
#7381
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for vitest-dev ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
sheremet-va
requested changes
Feb 4, 2025
docs/api/expect.md
Outdated
| @@ -701,6 +701,8 @@ You can provide an optional argument to test that a specific error is thrown: | |||
|
|
|||
| :::tip | |||
| You must wrap the code in a function, otherwise the error will not be caught, and test will fail. | |||
|
|
|||
| > _This only applies to the synchronous usage !_ | |||
There was a problem hiding this comment.
- The formatting doesn't follow docs style
- This not makes it more confusing - I had to reread the issue to understand what you mean here.
This needs a proper explanation with an example
There was a problem hiding this comment.
I've added the explanation given in the issue too and put an example below it (see updated screenshot)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
close #6558
Description
In #6558 it was mentioned to add a note to
expect.toThrowError(live, preview) about the TIP being "sync only".Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.