diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-02-09 06:44:34 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-02-11 13:33:26 +0300 |
| commit | 8d8f7c6e17be62771b1f0b0f02d257fc435496c2 (patch) | |
| tree | ae923299bbb6a969e1940f85222f43a1dbd18629 /doc/api/assert.md | |
| parent | 7e386295c553a009edfa21aa66596919f2612863 (diff) | |
doc: revise deepEqual() legacy assertion mode text
* 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>
Diffstat (limited to 'doc/api/assert.md')
| -rw-r--r-- | doc/api/assert.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 8a33005f362..9d513f9a0f8 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -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 |