michelsalib / chai-shallow-deep-equal

Shallow deep equal for chai
20 stars 9 forks source link

Document what 'shallow deep-equal' is #1

Closed Bartvds closed 10 years ago

Bartvds commented 10 years ago

After looking through the tests I think I get what you mean by 'shallow deep-equal', but maybe it's helpful to add a note to the readme describing the behaviour.

michelsalib commented 10 years ago

You are totally right, this plugin is currently missing a real documentation. I'll find some time to do it tomorrow. :)

michelsalib commented 10 years ago

done :)

Bartvds commented 10 years ago

Cool, this matches my observation :)

Thanks.

Also: you can probably add this to http://chaijs.com/plugins (PR on https://github.com/chaijs/chai-docs/blob/master/plugins.js)