Skip to content

Commit ba9fae0

Browse files
Trottcodebytere
authored andcommitted
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: #31704 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent f6d78f9 commit ba9fae0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/assert.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,9 @@ An alias of [`assert.deepStrictEqual()`][].
196196
197197
Tests for deep equality between the `actual` and `expected` parameters. Consider
198198
using [`assert.deepStrictEqual()`][] instead. [`assert.deepEqual()`][] can have
199-
potentially surprising results.
199+
surprising results.
200200

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

204204
### Comparison details

0 commit comments

Comments
 (0)