From bf95392e86fec7c804ab7ce3c9fcb968e9bf1601 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 26 Mar 2018 16:06:15 -0700 Subject: [PATCH] doc: improve assert legacy text This changes a sentence fragment into a full sentence and provides a few other minor improvements. PR-URL: https://github.com/nodejs/node/pull/19622 Reviewed-By: Vse Mozhet Byt Reviewed-By: Shingo Inoue Reviewed-By: Ruben Bridgewater --- doc/api/assert.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index 1646145a19bb2c..5df4edbf81dce4 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -37,8 +37,8 @@ const assert = require('assert').strict; > Stability: 0 - Deprecated: Use strict mode instead. When accessing `assert` directly instead of using the `strict` property, the -[Abstract Equality Comparison][] will be used for any function without a -"strict" in its name (e.g. [`assert.deepEqual()`][]). +[Abstract Equality Comparison][] will be used for any function without "strict" +in its name, such as [`assert.deepEqual()`][]. It can be accessed using: @@ -47,11 +47,9 @@ const assert = require('assert'); ``` It is recommended to use the [`strict mode`][] instead as the -[Abstract Equality Comparison][] can often have surprising results. Especially -in case of [`assert.deepEqual()`][] as the used comparison rules there are very -lax. - -E.g. +[Abstract Equality Comparison][] can often have surprising results. This is +especially true for [`assert.deepEqual()`][], where the comparison rules are +lax: ```js // WARNING: This does not throw an AssertionError!