Skip to content

docs: Clarify assert.doesNotThrow behavior - #2807

Closed
foliveira wants to merge 1 commit into
nodejs:masterfrom
foliveira:2385-assert-doesNotThrow-docs
Closed

docs: Clarify assert.doesNotThrow behavior#2807
foliveira wants to merge 1 commit into
nodejs:masterfrom
foliveira:2385-assert-doesNotThrow-docs

Conversation

@foliveira

@foliveirafoliveira commented Sep 11, 2015

Copy link
Copy Markdown
Contributor

Relates to #2385

The documentation now seems to be up to date with the code and tests for the assert module

@ChALkeRChALkeR added doc Issues and PRs related to the documentations. assert Issues and PRs related to the assert subsystem. labels Sep 11, 2015
Trott
Trott reviewed Sep 11, 2015
View reviewed changes
Comment threaddoc/api/assert.markdown Outdated

@TrottTrottSep 11, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

While we're at it, can we fix the comma splice here? This should be two sentences. ...not to throw an error. See...

@foliveira

foliveira commented Sep 11, 2015

Copy link
Copy Markdown
ContributorAuthor

@Trott updated the branch with your suggestions

Trott
Trott reviewed Sep 11, 2015
View reviewed changes
Comment threaddoc/api/assert.markdown Outdated

@TrottTrottSep 11, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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().

@foliveirafoliveira mentioned this pull request Sep 11, 2015
Closed
Trott
Trott reviewed Sep 11, 2015
View reviewed changes
Comment threaddoc/api/assert.markdown Outdated

@TrottTrottSep 11, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this might be clearer if you stayed away from AssertionError. I'd go with maybe SyntaxError.

@Trott

Trott commented Sep 11, 2015

Copy link
Copy Markdown
Member

I made several suggested changes with inline comments, but LGTM. /cc @nodejs/documentation

@foliveira

foliveira commented Sep 11, 2015

Copy link
Copy Markdown
ContributorAuthor

@Trott thanks for the tips/suggestions. All should be fixed now.

@Trott

Trott commented Sep 11, 2015

Copy link
Copy Markdown
Member

👍

LGTM

@foliveira
docs: Clarify assert.doesNotThrow behavior
e8bb02f
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.
@foliveira
foliveiraforce-pushed the 2385-assert-doesNotThrow-docs branch from e7e4c1a to e8bb02fCompareSeptember 14, 2015 13:14
@foliveira

foliveira commented Sep 14, 2015

Copy link
Copy Markdown
ContributorAuthor

Pushed rebased commits

@Trott

Trott commented Sep 14, 2015

Copy link
Copy Markdown
Member

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.

@silverwindsilverwind mentioned this pull request Sep 23, 2015
Closed
Trott pushed a commit that referenced this pull request Sep 23, 2015
@foliveira@Trott
docs: Clarify assert.doesNotThrow behavior
79ebeab
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 <rtrott@gmail.com>
@Trott

Trott commented Sep 23, 2015

Copy link
Copy Markdown
Member

Landed in 79ebeab. Thanks!

@TrottTrott closed this Sep 23, 2015
Fishrock123 pushed a commit that referenced this pull request Sep 25, 2015
@foliveira@Fishrock123
docs: Clarify assert.doesNotThrow behavior
b28f6a5
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 <rtrott@gmail.com>
This was referenced Sep 30, 2015
Closed
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

assertIssues and PRs related to the assert subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@foliveira@Trott@ChALkeR