Commit bf95392
doc: improve assert legacy text
This changes a sentence fragment into a full sentence and provides a few
other minor improvements.
PR-URL: #19622
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent e48cc3c commit bf95392
1 file changed
Lines changed: 5 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -37,8 +37,8 @@ const assert = require('assert').strict; | |||
| 37 | 37 | > Stability: 0 - Deprecated: Use strict mode instead. | |
| 38 | 38 | ||
| 39 | 39 | When accessing `assert` directly instead of using the `strict` property, the | |
| 40 | - [Abstract Equality Comparison][] will be used for any function without a | ||
| 41 | - "strict" in its name (e.g. [`assert.deepEqual()`][]). | ||
| 40 | + [Abstract Equality Comparison][] will be used for any function without "strict" | ||
| 41 | + in its name, such as [`assert.deepEqual()`][]. | ||
| 42 | 42 | ||
| 43 | 43 | It can be accessed using: | |
| 44 | 44 | ||
@@ -47,11 +47,9 @@ const assert = require('assert'); | |||
| 47 | 47 | ``` | |
| 48 | 48 | ||
| 49 | 49 | It is recommended to use the [`strict mode`][] instead as the | |
| 50 | - [Abstract Equality Comparison][] can often have surprising results. Especially | ||
| 51 | - in case of [`assert.deepEqual()`][] as the used comparison rules there are very | ||
| 52 | - lax. | ||
| 53 | - | ||
| 54 | - E.g. | ||
| 50 | + [Abstract Equality Comparison][] can often have surprising results. This is | ||
| 51 | + especially true for [`assert.deepEqual()`][], where the comparison rules are | ||
| 52 | + lax: | ||
| 55 | 53 | ||
| 56 | 54 | ```js | |
| 57 | 55 | // WARNING: This does not throw an AssertionError! | |
0 commit comments