docs(assert): improve assertObjectMatch docs
#5296
Merged
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
kt3k
commented
Jul 4, 2024
assert/object_match.ts
Outdated
| @@ -3,7 +3,7 @@ | |||
| import { assertEquals } from "./equals.ts"; | |||
|
|
|||
| /** | |||
| * Make an assertion that `actual` object is a subset of `expected` object, | |||
| * Make an assertion that `actual` object is a superset of `expected` object, | |||
There was a problem hiding this comment.
actual needs to include all of expected fields. I think actual is called superset in this case.
There was a problem hiding this comment.
I think it'd be a little easier to understand if we say that expected is a subset of actual. WDYT?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5296 +/- ##
=======================================
Coverage 95.80% 95.81%
=======================================
Files 457 458 +1
Lines 37955 37890 -65
Branches 5572 5567 -5
=======================================
- Hits 36364 36304 -60
+ Misses 1551 1546 -5
Partials 40 40 ☔ View full report in Codecov by Sentry. |
iuioiua
approved these changes
Jul 4, 2024
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.
This PR improves the docs of
assertObjectMatch.