Skip to content

doc: revise deepEqual() legacy assertion mode text #31704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Trott merged 1 commit into from
Feb 11, 2020
Merged

doc: revise deepEqual() legacy assertion mode text #31704

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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>
  • Loading branch information
@Trott
Trott committed Feb 11, 2020
commit 8d8f7c6e17be62771b1f0b0f02d257fc435496c2
4 changes: 2 additions & 2 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down