From 8e213096df8c1d5097578fd94a625f9703a952bd Mon Sep 17 00:00:00 2001 From: David Boivin Date: Thu, 10 Sep 2015 10:14:47 -0500 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/2799 Reviewed-By: Jeremiah Senkpiel Reviewed-By: Rich Trott Reviewed-By: Roman Reiss --- doc/api/assert.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index bb7a8fbead..fd1130eebe 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -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)