Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments #4720

vjpr · 2020-04-09T23:50:15Z

I just ran into the same issue as here: #2798

It current says "The comparator is invoked with two arguments: (arrVal, othVal).". I assumed that arrVal was the first array, and othVal would always be one of the other arrays.

When you read "The order and references of result values are determined by the first array", it also makes you think that arrVal is always the first array.

Also the signature is written as:

_.intersectionWith(objects, others, _.isEqual);

It should be made clear that the params of the comparator can be either objects or any of the others arrays.

vjpr changed the title ~~Update docs for `_.intersectionWith` comparator fo avoid confusion~~ Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments Apr 9, 2020

lodash / lodash

Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments #4720

Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments #4720

vjpr commented Apr 9, 2020

lodash / lodash

Join GitHub today

Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments #4720

Update docs for `_.intersectionWith` comparator to avoid confusion regarding comparator argments #4720

Comments

vjpr commented Apr 9, 2020