Skip to content

Commit

Permalink
doc: remove "note that" from assert.md
Browse files Browse the repository at this point in the history
Refs: nodejs/remark-preset-lint-node#16

PR-URL: #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>
  • Loading branch information
Trott authored and targos committed Jul 2, 2019
1 parent d384911 commit d759e0f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit d759e0f

Please sign in to comment.