Skip to content

doc: add warning to assert.doesNotThrow() #18699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 2 commits into from
Closed

doc: add warning to assert.doesNotThrow() #18699

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a23156
doc: add warning to assert.doesNotThrow()
BridgeAR Feb 10, 2018
697c2e3
fixup
BridgeAR Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup
  • Loading branch information
@BridgeAR
BridgeAR committed Mar 6, 2018
commit 697c2e3b8d526f7471de879858f8ffc1674a8b32
8 changes: 4 additions & 4 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,10 @@ changes:
Asserts that the function `block` does not throw an error. See
[`assert.throws()`][] for more details.

Please note: Using `assert.doesNotThrow()` is not recommended because there is
no benefit by catching an error and then rethrowing it. Instead, consider adding
a comment next to the specific code path that should not throw and keep all
error messages in your code as expressive as possible.
Please note: Using `assert.doesNotThrow()` is actually not useful because there
is no benefit by catching an error and then rethrowing it. Instead, consider
adding a comment next to the specific code path that should not throw and keep
error messages as expressive as possible.
Copy link
Copy Markdown
Member

@jasnell jasnell Mar 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested rewording ...

The `assert.doesNotThrow()` method is not as useful in practice as it may
first appear. Consider, instead, adding comments to the specific code paths
that should not throw errors and keep error messages as expressive as possible.


When `assert.doesNotThrow()` is called, it will immediately call the `block`
function.
Expand Down