From 8574d91f272633a4560d6b2b8096943246d3d23c Mon Sep 17 00:00:00 2001 From: Wyatt Preul Date: Mon, 4 Jan 2016 22:14:40 -0600 Subject: [PATCH] doc: stronger suggestion for userland assert Fixes: https://github.com/nodejs/node/issues/4532 PR-URL: https://github.com/nodejs/node/pull/4535 Reviewed-By: Colin Ihrig Reviewed-By: Evan Lucas Reviewed-By: James M Snell Reviewed-By: Sam Roberts Reviewed-By: Roman Reiss --- doc/api/assert.markdown | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown index bab280f325ff27..cf710c6ed4ced0 100644 --- a/doc/api/assert.markdown +++ b/doc/api/assert.markdown @@ -2,10 +2,11 @@ Stability: 3 - Locked -The `assert` module provides a simple set of assertion tests that can be used -to test invariants and implement unit tests. While the `assert` module is -generally intended for internal use by Node.js itself, it can be used by user -code calling `require('assert')`. +The `assert` module provides a simple set of assertion tests that can be used to +test invariants. The module is intended for internal use by Node.js, but can be +used in application code via `require('assert')`. However, `assert` is not a +testing framework, and is not intended to be used as a general purpose assertion +library. The API for the `assert` module is [Locked][]. This means that there will be no additions or changes to any of the methods implemented and exposed by