Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request polishes the documentation for the chaiConfig configuration option by expanding it with detailed explanations and examples for the truncateThreshold and showDiff properties, while removing the unused includeStack property from the type definition.
Changes:
- Removed
includeStackfield from ChaiConfig type definition in documentation (with a TODO comment added in TypeScript noting it seems unused) - Added comprehensive documentation for
truncateThresholdwith examples showing truncated vs full output - Added comprehensive documentation for
showDiffwith examples demonstrating diff output vs plain text
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| website/docs/en/config/test/chai-config.mdx | Expanded English documentation with detailed sections for truncateThreshold and showDiff, removed includeStack |
| website/docs/zh/config/test/chai-config.mdx | Expanded Chinese documentation with detailed sections for truncateThreshold and showDiff, removed includeStack |
| packages/core/src/types/config.ts | Added TODO comment noting that chaiConfig.includeStack seems not used |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying rstest with
|
| Latest commit: |
135c69a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://651138bc.rstest.pages.dev |
| Branch Preview URL: | https://truncatethreshold.rstest.pages.dev |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
Summary
docs: polish chaiConfig
Related Links
Checklist