docs: add comprehensive documentation for containSubset assertion #1739
+91
−17
Conversation
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
- Enhanced JSDoc for .containSubset() in BDD interface with detailed examples - Documented object and array comparison behavior - Added examples for nested structures, function validators, and Date objects - Improved assert.containsSubset() documentation with clear examples - Enhanced assert.doesNotContainSubset() documentation - Added optional message parameter documentation Fixes chaijs#1738
43081j
reviewed
Nov 10, 2025
43081j
previously approved these changes
Nov 10, 2025
Contributor
43081j
left a comment
There was a problem hiding this comment.
looks good to me 👍
thanks for the help 🙏
Co-authored-by: James Garbutt <43081j@users.noreply.github.com>
Contributor
Author
|
Thanks a lot for the review and suggestions! Happy to contribute 😊 |
43081j
approved these changes
Nov 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Adds comprehensive JSDoc documentation for the
containSubsetassertion that was added in #1664 but was never documented.Changes Made
BDD Interface (
lib/chai/core/assertions.js).containSubset()method with detailed descriptions.notsubsetparametermsgparameterAssert Interface (
lib/chai/interface/assert.js)assert.containsSubset()assert.doesNotContainSubset()Testing
Fixes
Closes #1738
Additional Notes
This documentation follows the same format and style as other assertions in the codebase (e.g.,
.include(),.equal(), etc.). The documentation will be picked up by the documentation generation tools to update https://www.chaijs.com/api/bdd/