From 1bbd62bb79bb65e41650ace46c6d941de7c7c064 Mon Sep 17 00:00:00 2001 From: David Boivin Date: Thu, 10 Sep 2015 10:14:47 -0500 Subject: [PATCH 1/4] 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. --- doc/api/assert.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 59b7155bf99619..99e5cb8a176596 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,7 +2,7 @@ Stability: 2 - Stable -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) From e0164fe2ce9f367693e05592507e50979ae2f204 Mon Sep 17 00:00:00 2001 From: David Boivin Date: Thu, 10 Sep 2015 13:13:18 -0500 Subject: [PATCH 2/4] Update assert.markdown Correct comma splice --- doc/api/assert.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 99e5cb8a176596..bde285ad645749 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,7 +2,7 @@ Stability: 2 - Stable -This module is used for testing actual values against expected values, 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) From 552573463ac88737e34fd9230948f3809381fb15 Mon Sep 17 00:00:00 2001 From: David Boivin Date: Mon, 14 Sep 2015 14:09:35 -0500 Subject: [PATCH 3/4] Update assert.markdown Keep the summary simple while describing the entire module. --- doc/api/assert.markdown | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index bde285ad645749..58f6920414fddc 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,8 +2,7 @@ Stability: 2 - Stable -This module is used for testing actual values against expected values. 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) From e7b728748177cc6836ed292ce46e67c33a7473d9 Mon Sep 17 00:00:00 2001 From: David Boivin Date: Fri, 9 Oct 2015 11:55:53 -0500 Subject: [PATCH 4/4] wrap at 80 characters --- doc/api/assert.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index 58f6920414fddc..f483762dc04b23 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,7 +2,8 @@ Stability: 2 - Stable -This module is used for writing assertion tests. 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)