docs: update snapshot section to provide details on how to use with concurrent test #2733
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
sheremet-va
requested changes
Feb 3, 2023
docs/guide/features.md
Outdated
| @@ -44,16 +44,16 @@ Learn more about [Test Filtering](./filtering.md). | |||
|
|
|||
| ## Running tests concurrently | |||
|
|
|||
| Use `.concurrent` in consecutive tests to run them in parallel. | |||
| Use `.concurrent` in consecutive tests to run them in parallel. Also, be sure to use `expect` from the [Test Context](/guide/test-context.md) to ensure the right test is being detected. | |||
There was a problem hiding this comment.
I think we should add ::warning section and mention snapshot testing there and expect.assertions. Otherwise, it doesn't matter what expect you use there.
sheremet-va
requested changes
Feb 11, 2023
docs/api/index.md
Outdated
| @@ -149,13 +149,15 @@ You cannot use this syntax, when using Vitest as [type checker](/guide/testing-t | |||
| test.todo.concurrent(/* ... */) // or test.concurrent.todo(/* ... */) | |||
| ``` | |||
|
|
|||
| When using Snapshots with async concurrent tests, due to the limitation of JavaScript, you need to use the `expect` from the [Test Context](/guide/test-context.md) to ensure the right test is being detected. | |||
| When using Snapshots with async concurrent tests, you need to use `expect` from the [Test Context](/guide/test-context.md) and call `expect.assertions` to ensure the test will detect any failures. | |||
There was a problem hiding this comment.
No, I did not mean that. You don't need to call expect.assertions in this case. You need to use local expect, if you are calling assertions in a concurrent test. This is also true for your other edits. We just need to mention that this API depends on the local expect in this case.
|
@dammy001 can you review this PR, please? |
dammy001
reviewed
Feb 13, 2023
remove extra spaces Co-authored-by: Anjorin Damilare <damilareanjorin1@gmail.com>
sheremet-va
approved these changes
Feb 14, 2023
sheremet-va
changed the title
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.
docs: update Snapshot section to provide details on how to use with concurrent test
close #2729