Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify the difference between toIncludeAllMembers and toIncludeSameMembers #647

Closed
wants to merge 3 commits into from
Closed

docs: clarify the difference between toIncludeAllMembers and toIncludeSameMembers #647

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8144905
docs: clarify difference between toIncludeAllMembers and toIncludeSam…
devjiwonchoi Sep 5, 2023
1b9bfaf
chore: update docs and add test
devjiwonchoi Sep 5, 2023
9467c0b
docs: update toIncludeSameMembers
devjiwonchoi Oct 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/docs/matchers/Array.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Use `.toIncludeAllMembers` when checking if an `Array` contains all of the membe

### .toIncludeAllPartialMembers([members])

Use `.toIncludeAllPartialMembers` when checking if an `Array` contains all of the partial members of a given set.
Use `.toIncludeAllPartialMembers` when checking if an `Array` contains all of the partial members of a given set, in any order.

<TestFile name="toIncludeAllPartialMembers">
{`test('passes when given array values match the partial members of the set', () => {
Expand All @@ -62,13 +62,13 @@ Use `.toIncludeAnyMembers` when checking if an `Array` contains any of the membe

### .toIncludeSameMembers([members])

Use `.toIncludeSameMembers` when checking if two arrays contain equal values, in any order.
Use `.toIncludeSameMembers` when checking if two arrays contain members in exact match, in any order.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is clearer. The matcher is using the equals function, which is why the original was worded the way it was.


<TestFile name="toIncludeSameMembers">
{`test('passes when arrays match in a different order', () => {
expect([1, 2, 3]).toIncludeSameMembers([3, 1, 2]);
expect([{ foo: 'bar' }, { baz: 'qux' }]).toIncludeSameMembers([{ baz: 'qux' }, { foo: 'bar' }]);
expect([{ foo: 'bar' }, { baz: 'qux' }, { fred: 'thud' }]).not.toIncludeSameMembers([{ baz: 'qux' }, { foo: 'bar' }]);
expect([1, 2, 2]).not.toIncludeSameMembers([2, 1]);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change this?

});`}
</TestFile>

Expand Down