Conversation
✅ Deploy Preview for rstest-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the TestContext interface to the test API documentation. The changes improve type clarity by explicitly naming the context parameter and providing comprehensive documentation for the TestContext interface.
- Updates type signatures to use explicit
testContext: TestContextparameter naming instead of genericcontext - Adds new
TestContextinterface documentation with its properties and usage examples - Corrects the return type of
expect.pollto includePromise<Assertion<T>>
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| website/docs/zh/api/test-api/test.mdx | Adds TestContext documentation and updates type signatures in Chinese documentation |
| website/docs/zh/api/test-api/expect.mdx | Corrects expect.poll return type to Promise in Chinese documentation |
| website/docs/en/api/test-api/test.mdx | Adds TestContext documentation and updates type signatures in English documentation |
| website/docs/en/api/test-api/expect.mdx | Corrects expect.poll return type to Promise in English documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| }); | ||
|
|
||
| testWithUser('has user in context', ({ user, expect }) => { | ||
| testWithUser('has user in test context', ({ user, expect }) => { |
There was a problem hiding this comment.
[nitpick] The comment text was changed from 'context' to 'test context' but this appears to be an unnecessary change that doesn't improve clarity and creates inconsistency with the English version.
| testWithUser('has user in test context', ({ user, expect }) => { | |
| testWithUser('has user in context', ({ user, expect }) => { |
Summary
add
TestContextdoc.Related Links
Checklist