Skip to content

Commit 7472713

Browse files
daveboivinjasnell
authored andcommitted
doc: update the assert module summary
The current wording "This module is used for writing unit tests for your applications, you can access it with require('assert')." implies that this module should only be used in development while unit testing. The article "Error Handling in Node.js" by Joyent (https://www.joyent.com/developers/node/design/errors) uses the assert module in an efficient way to validate required function arguments. PR-URL: #2799 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
1 parent 0d50655 commit 7472713

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/assert.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Stability: 2 - Stable
44

5-
This module is used for writing unit tests for your applications. You can
6-
access it with `require('assert')`.
5+
This module is used for writing assertion tests. You can access it with
6+
`require('assert')`.
77

88
## assert.fail(actual, expected, message, operator)
99

0 commit comments

Comments
 (0)