Skip to content

Commit

Permalink
doc: revise deepEqual() legacy assertion mode text
Browse files Browse the repository at this point in the history
* Remove "potentially". It's arguably misplaced and certainly
  unnecessary.
* Use italics for words-as-words usage of _Deep equality_ rather than
  using quotation marks.

PR-URL: nodejs#31704
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
Trott committed Feb 11, 2020
1 parent 7e38629 commit 8d8f7c6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,9 @@ An alias of [`assert.deepStrictEqual()`][].
Tests for deep equality between the `actual` and `expected` parameters. Consider
using [`assert.deepStrictEqual()`][] instead. [`assert.deepEqual()`][] can have
potentially surprising results.
surprising results.

"Deep" equality means that the enumerable "own" properties of child objects
_Deep equality_ means that the enumerable "own" properties of child objects
are also recursively evaluated by the following rules.

### Comparison details
Expand Down

0 comments on commit 8d8f7c6

Please sign in to comment.