From 1db85aa71ca59dd9f901472b17cedcaa296d838f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 8 Feb 2020 17:44:34 -1000 Subject: [PATCH] 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 Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- doc/api/assert.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index c9f546e9fc50ab..5c4a7986ed71d7 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