diff options
author | Rich Trott <rtrott@gmail.com> | 2019-06-20 14:10:15 -0600 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-06-23 07:10:06 -0700 |
commit | 7696663691d5b65f032772a0f6179acc59b0a3a2 (patch) | |
tree | fa93ef4a544531be6195c8b858741e3dc5f2cd0b /doc/api/assert.md | |
parent | fafd98404ddb6f25a20f67bd30e342045a922e9a (diff) | |
download | android-node-v8-7696663691d5b65f032772a0f6179acc59b0a3a2.tar.gz android-node-v8-7696663691d5b65f032772a0f6179acc59b0a3a2.tar.bz2 android-node-v8-7696663691d5b65f032772a0f6179acc59b0a3a2.zip |
doc: remove "note that" from assert.md
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/16
PR-URL: https://github.com/nodejs/node/pull/28329
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/assert.md')
-rw-r--r-- | doc/api/assert.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index 822e05aa1c..cc65dbcf6e 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -115,7 +115,7 @@ assert.deepEqual([[[1, 2, 3]], 4, 5], [[[1, 2, '3']], 4, 5]); ``` To deactivate the colors, use the `NODE_DISABLE_COLORS` environment variable. -Please note that this will also deactivate the colors in the REPL. +This will also deactivate the colors in the REPL. ## Legacy mode @@ -1029,7 +1029,7 @@ assert.rejects( }); ``` -Note that `error` cannot be a string. If a string is provided as the second +`error` cannot be a string. If a string is provided as the second argument, then `error` is assumed to be omitted and the string will be used for `message` instead. This can lead to easy-to-miss mistakes. Please read the example in [`assert.throws()`][] carefully if using a string as the second @@ -1131,7 +1131,7 @@ assert.throws( nested: true, baz: 'text' } - // Note that only properties on the validation object will be tested for. + // Only properties on the validation object will be tested for. // Using nested objects requires all properties to be present. Otherwise // the validation is going to fail. } @@ -1217,7 +1217,7 @@ assert.throws( ); ``` -Note that `error` cannot be a string. If a string is provided as the second +`error` cannot be a string. If a string is provided as the second argument, then `error` is assumed to be omitted and the string will be used for `message` instead. This can lead to easy-to-miss mistakes. Using the same message as the thrown error message is going to result in an |