summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-03-26 16:06:15 -0700
committerBeth Griggs <Bethany.Griggs@uk.ibm.com>2018-12-04 11:51:12 +0000
commitbf95392e86fec7c804ab7ce3c9fcb968e9bf1601 (patch)
tree520ea787da9afdfe929ade0c12e2e84005d4926f
parente48cc3c4039ea3aab62935d34bff419a6688d7a2 (diff)
downloadnode-new-bf95392e86fec7c804ab7ce3c9fcb968e9bf1601.tar.gz
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.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index 1646145a19..5df4edbf81 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!