doc: improve assert documentation #22692
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes the officially accepted message types for `assert.throws()`, `assert.rejects()`, `assert.doesNotThrow()` and `assert.doesNotReject()`. It also renames the `block` argument in those functions to `fn` and `promiseFn` for further clarity.
nodejs-github-bot
added
assert
lpinca
approved these changes
Sep 5, 2018
vsemozhetbyt
reviewed
Sep 5, 2018
doc/api/assert.md
Outdated
| If specified, `message` will be the message provided by the `AssertionError` if | ||
| the block fails to throw. | ||
| If specified, `message` will be appended to the message provided by the | ||
| `AssertionError` if the fn call fails to throw or in case the error validation |
vsemozhetbyt
approved these changes
Sep 5, 2018
addaleax
approved these changes
Sep 5, 2018
doc/api/assert.md
Outdated
| @@ -408,19 +408,19 @@ parameter is undefined, a default error message is assigned. If the `message` | |||
| parameter is an instance of an [`Error`][] then it will be thrown instead of the | |||
| `AssertionError`. | |||
|
|
|||
| ## assert.doesNotReject(block[, error][, message]) | |||
| ## assert.doesNotReject(promiseFn[, error][, message]) | |||
There was a problem hiding this comment.
How about asyncFn? That’s more or less the name the language settled on…
BridgeAR
added
the
author ready
jasnell
approved these changes
Sep 5, 2018
gdams
approved these changes
Sep 7, 2018
|
landed in: c1483ba |
gdams
pushed a commit
that referenced
this pull request
Sep 7, 2018
This fixes the officially accepted message types for `assert.throws()`, `assert.rejects()`, `assert.doesNotThrow()` and `assert.doesNotReject()`. It also renames the `block` argument in those functions to `fn` and `promiseFn` for further clarity. PR-URL: #22692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>
|
The argument names should have been changed in the code as well or else not changed in the docs. > assert.throws('hey', 'jude')
TypeError [ERR_INVALID_ARG_TYPE]: The "block" argument must be of type Function. Received type string
at getActual (assert.js:560:11)
at Function.throws (assert.js:680:24)
> The user doesn't have a way of knowing what the "block" argument is without looking at Node.js source code. They should be able to figure it out by looking at the docs. Before this change, they could. Now they can't. |
targos
pushed a commit
that referenced
this pull request
Sep 8, 2018
This fixes the officially accepted message types for `assert.throws()`, `assert.rejects()`, `assert.doesNotThrow()` and `assert.doesNotReject()`. It also renames the `block` argument in those functions to `fn` and `promiseFn` for further clarity. PR-URL: #22692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes the officially accepted message types for
assert.throws(),assert.rejects(),assert.doesNotThrow()andassert.doesNotReject(). It also renames theblockargument inthose functions to
fnandpromiseFnfor further clarity.Errors would be ambiguous and were never intended to be special
handled as message. They are "accepted" in case it's the third argument
by coercing those to a string.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes