Updating docs for .toEqual (#3556)

* Updating docs for `.toEqual` Fixes #3529 * Update ExpectAPI.md
jestjs · May 12, 2017 · 6a12116 · 6a12116
1 parent bb977d4
commit 6a12116
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/en/ExpectAPI.md b/docs/en/ExpectAPI.md
@@ -666,6 +666,8 @@ describe('the La Croix cans on my desk', () => {
 });
 ```
 
+> Note: `.toEqual` won't perform a *deep equality* check for two errors. Only the `message` property of an Error is considered for equality. It is recommended to use the `.toThrow` matcher for testing against errors.
+
 ### `.toHaveLength(number)`
 
 Use `.toHaveLength` to check that an object has a `.length` property and it is set to a certain numeric value.