diff options
author | Rich Trott <rtrott@gmail.com> | 2018-03-26 16:06:15 -0700 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2018-03-27 01:27:39 +0100 |
commit | 12f69ddfef613470279e3aefef876fb1ff912297 (patch) | |
tree | 847886a4db7f0bca4fb13b0b79dc89b1b7306ddb | |
parent | ce2ed584c826f22c94f89ceb2eb60a1facbb7c95 (diff) | |
download | android-node-v8-12f69ddfef613470279e3aefef876fb1ff912297.tar.gz android-node-v8-12f69ddfef613470279e3aefef876fb1ff912297.tar.bz2 android-node-v8-12f69ddfef613470279e3aefef876fb1ff912297.zip |
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 <vsemozhetbyt@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
-rw-r--r-- | doc/api/assert.md | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 95ab139c7d..c26628bd84 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -73,8 +73,8 @@ Please note that this will also deactivate the colors in the REPL. > 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: @@ -83,11 +83,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! |