Commit ede98d1
doc: stronger suggestion for userland assert
Fixes: #4532
PR-URL: #4535
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>1 parent fdfc72c commit ede98d1
1 file changed
Lines changed: 5 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,10 +2,11 @@ | |||
| 2 | 2 | ||
| 3 | 3 | Stability: 3 - Locked | |
| 4 | 4 | ||
| 5 | - The `assert` module provides a simple set of assertion tests that can be used | ||
| 6 | - to test invariants and implement unit tests. While the `assert` module is | ||
| 7 | - generally intended for internal use by Node.js itself, it can be used by user | ||
| 8 | - code calling `require('assert')`. | ||
| 5 | + The `assert` module provides a simple set of assertion tests that can be used to | ||
| 6 | + test invariants. The module is intended for internal use by Node.js, but can be | ||
| 7 | + used in application code via `require('assert')`. However, `assert` is not a | ||
| 8 | + testing framework, and is not intended to be used as a general purpose assertion | ||
| 9 | + library. | ||
| 9 | 10 | ||
| 10 | 11 | The API for the `assert` module is [Locked][]. This means that there will be no | |
| 11 | 12 | additions or changes to any of the methods implemented and exposed by | |
0 commit comments