doc: update the assert module summary
authorDavid Boivin <dave.a.boivin@gmail.com>
Thu, 10 Sep 2015 15:14:47 +0000 (10:14 -0500)
committerJames M Snell <jasnell@gmail.com>
Mon, 12 Oct 2015 13:42:20 +0000 (06:42 -0700)
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: https://github.com/nodejs/node/pull/2799
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
doc/api/assert.markdown

index bb7a8fb..fd1130e 100644 (file)
@@ -2,8 +2,8 @@
 
     Stability: 2 - Stable
 
-This module is used for writing unit tests for your applications. You can
-access it with `require('assert')`.
+This module is used for writing assertion tests. You can access it with
+`require('assert')`.
 
 ## assert.fail(actual, expected, message, operator)