Skip to content

Commit ede98d1

Browse files
geekMyles Borins
authored and
Myles Borins
committed
doc: stronger suggestion for userland assert
Fixes: #4532 PR-URL: #4535 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
1 parent fdfc72c commit ede98d1

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

doc/api/assert.markdown

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
Stability: 3 - Locked
44

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.
910

1011
The API for the `assert` module is [Locked][]. This means that there will be no
1112
additions or changes to any of the methods implemented and exposed by

0 commit comments

Comments
 (0)