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: #31704
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and codebytere committed Mar 17, 2020
1 parent 6e79a17 commit 9821d93
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 @@ -196,9 +196,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 9821d93

Please sign in to comment.