diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-02-08 17:44:34 -1000 |
|---|---|---|
| committer | Shelley Vohr <shelley.vohr@gmail.com> | 2020-02-17 12:38:45 -0800 |
| commit | ba9fae058abd273934bf759ca4c89e060519c691 (patch) | |
| tree | 4cfc67964fb6ce88a8f36215acf74a081f1edda7 | |
| parent | f6d78f959f8e795f000c572c6c21edecda71fe42 (diff) | |
| download | node-new-ba9fae058abd273934bf759ca4c89e060519c691.tar.gz | |
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>
| -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 2b819c3e4e..384db3b02b 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -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 |