docs: Clarify assert.doesNotThrow behavior#2807
Uh oh!
There was an error while loading. Please reload this page.
Conversation
ChALkeR added doc 
doc/api/assert.markdown Outdated
There was a problem hiding this comment.
While we're at it, can we fix the comma splice here? This should be two sentences. ...not to throw an error. See...
foliveira commented Sep 11, 2015
@Trott updated the branch with your suggestions |
doc/api/assert.markdown Outdated
There was a problem hiding this comment.
Two more things (sorry!):
Should probably be assert.throws() with the parentheses, and that text should probably link to the section of the document for assert.throws().
doc/api/assert.markdown Outdated
There was a problem hiding this comment.
I think this might be clearer if you stayed away from AssertionError. I'd go with maybe SyntaxError.
Trott commented Sep 11, 2015
I made several suggested changes with inline comments, but LGTM. /cc @nodejs/documentation |
foliveira commented Sep 11, 2015
@Trott thanks for the tips/suggestions. All should be fixed now. |
Trott commented Sep 11, 2015
👍 LGTM |
The documentation for assert.doesNotThrow now reflects all the inputs the function accepts, as well as the errors thrown for each combination of parameter types.
foliveiraforce-pushed the 2385-assert-doesNotThrow-docs branch from e7e4c1a to e8bb02fComparefoliveira commented Sep 14, 2015
Pushed rebased commits |
Trott commented Sep 14, 2015
LGTM. It would be good if someone from @nodejs/documentation could look at it just to make sure it conforms with any emerging or established documentation guidelines that I may be unaware of. |
The documentation for assert.doesNotThrow now reflects all the inputs the function accepts, as well as the errors thrown for each combination of parameter types. PR-URL: #2807 Reviewed-By: Rich Trott <[email protected]>
Trott commented Sep 23, 2015
Landed in 79ebeab. Thanks! |
The documentation for assert.doesNotThrow now reflects all the inputs the function accepts, as well as the errors thrown for each combination of parameter types. PR-URL: #2807 Reviewed-By: Rich Trott <[email protected]>
3 participants
Relates to #2385
The documentation now seems to be up to date with the code and tests for the
assertmodule