1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: revise deepEqual() legacy assertion mode text

Browse Source 
* 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: https://github.com/nodejs/node/pull/31704
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2020-02-08 17:44:34 -10:00
parent 7e386295c5
commit 8d8f7c6e17
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/assert.md
View File

@ -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