Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for chainable modifiers functionality to the test API documentation. It explains how different modifiers can be combined together for both test and describe functions.
- Adds chainable modifiers section to both test.mdx and describe.mdx documentation files
- Provides practical examples of how to chain different modifiers like
only,runIf,skipIf,concurrent, andfor
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/docs/en/api/test-api/test.mdx | Added chainable modifiers section with examples for test API |
| website/docs/en/api/test-api/describe.mdx | Added chainable modifiers section with examples for describe API |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - `test.only.concurrent` (or `test.concurrent.only`) will only run the test block concurrently. | ||
| - `test.for(cases).concurrent` (or `test.concurrent.for(cases)`) will run the test block concurrently for each case in the provided array. | ||
| - ...... | ||
|
|
There was a problem hiding this comment.
Using '......' as an ellipsis is unprofessional in documentation. Consider either providing more specific examples or removing this line entirely.
| For a complete list of available chainable modifiers, see the API reference. |
| - `describe.skipIf(condition).concurrent` (or `describe.concurrent.skipIf(condition)`) will skip the describe block if the condition is true, otherwise run the tests concurrently. | ||
| - `describe.runIf(condition).concurrent` (or `describe.concurrent.runIf(condition)`) will only run the describe block concurrently if the condition is true. | ||
| - `describe.only.concurrent` (or `describe.concurrent.only`) will only run the describe block concurrently. | ||
| - ...... |
There was a problem hiding this comment.
Using '......' as an ellipsis is unprofessional in documentation. Consider either providing more specific examples or removing this line entirely.
| - ...... |
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary
add chainable modifiers examples for
describeandtestAPI.Related Links
Checklist