diff options
| author | daveboivin <dave.a.boivin@gmail.com> | 2015-07-30 16:58:48 -0500 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2015-08-05 11:13:50 -0700 |
| commit | 99414b3bb67584ea593318247a4ac0ea74640616 (patch) | |
| tree | 85513c78d6b36aba8c00764c20038d514dea8718 | |
| parent | be7eb832ea285b692164fb03c4732917c38013b6 (diff) | |
| download | node-99414b3bb67584ea593318247a4ac0ea74640616.tar.gz | |
Update assert.markdown
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.
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/joyent/node/pull/25786
| -rw-r--r-- | doc/api/assert.markdown | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 771a87338..dc93e9cdd 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,7 +2,7 @@ Stability: 5 - Locked -This module is used for writing unit tests for your applications, you can +This module is used for testing actual values against expected values, you can access it with `require('assert')`. ## assert.fail(actual, expected, message, operator) |