nubank / matcher-combinators

Library for creating matcher combinator to compare nested data structures
Other
468 stars 23 forks source link

Add note to equals docstring #168

Closed gianfun closed 2 years ago

gianfun commented 2 years ago

I recently realized that, for maps, equals does not have similar behavior to the clojure standard equals, as it only modifies the matches being done on the top level map.

This is stated in the readme (sections built-in matchers and overriding default matchers).

However, nothing is stated in the docstring (which is where I assume developers would look at more often, especially given IDE integrations). I've added a note there to try and make this more obvious.

I've also added an extra note in the README to highlight this point