doc: correct description of assert.ifError() #2941
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
Trott
added
assert
|
|
||
| ## assert.ifError(value) | ||
|
|
||
| Tests if value is not a false value, throws if it is a true value. Useful when | ||
| testing the first argument, `error` in callbacks. | ||
| Tests if value is an `Error` and, if so, throws it. This is useful when |
There was a problem hiding this comment.
It doesn't actually check if it is an Error.
There was a problem hiding this comment.
The original text is correct, just kind of worded in a way that's easy to misunderstand. throws if it is a true value makes it sound like it throws an error if the value is true. But what it actually does is it throws the value itself, as long as it is truthy. I'll attempt a re-wording that won't make it WRONG...
There was a problem hiding this comment.
Pushed a revision. Better?
|
LGTM with a suggestion |
|
LGTM - targo's suggestion. |
This fixes a few typographical errors (comma splices and the like) and corrects the description of assert.ifError().
It throws if `value` is truthy.
Trott
force-pushed
the
assert-comma-splice
branch
from
9499062
to
7c4a8f3
Compare
|
Changed both instances of |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Sep 19, 2015
This fixes a few typographical errors (comma splices and the like) and clarifies the description of assert.ifError(). It also standardizes the document on "inequality" rather than having both "inequality" and "non- equality". PR-URL: nodejs#2941 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
|
Landed in 4fb4c14 |
Trott
added a commit
that referenced
this pull request
Sep 20, 2015
This fixes a few typographical errors (comma splices and the like) and clarifies the description of assert.ifError(). It also standardizes the document on "inequality" rather than having both "inequality" and "non- equality". PR-URL: #2941 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]>
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 a few typographical errors (comma splices and the like) and
corrects the description of assert.ifError().