Skip to content
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

Jump to bottom

doc: add docs for AssertionError #14261

Closed
wants to merge 2 commits into from
Closed

doc: add docs for AssertionError #14261

wants to merge 2 commits into from

Conversation

daxlab
Copy link
Contributor

@daxlab daxlab commented Jul 16, 2017 •
edited
Loading

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. errors Issues and PRs related to JavaScript errors originated in Node.js core. labels Jul 16, 2017
@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Jul 16, 2017 •
edited
Loading

Thank you!

Linter CI: https://ci.nodejs.org/job/node-test-linter/10517/ (is green)

@vsemozhetbyt vsemozhetbyt added the assert Issues and PRs related to the assert subsystem. label Jul 16, 2017
cjihrig
cjihrig reviewed Jul 16, 2017
View reviewed changes
doc/api/errors.md Outdated
For example:

```js
assert.equal(1, 2);
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd recommend using strictEqual() here to help set readers up for success :-)

tniessen
tniessen approved these changes Jul 16, 2017
View reviewed changes
doc/api/errors.md
## Class: AssertionError

A subclass of `Error` that indicates the failure of an assertion. Such errors
commonly indicate inequality of actual and expected parameters.
Copy link
Member

Choose a reason for hiding this comment

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

IMO this could as well be "values" instead of "parameters", still LGTM.

XadillaX
XadillaX approved these changes Aug 10, 2017
View reviewed changes
Copy link
Contributor

@XadillaX XadillaX left a comment

Choose a reason for hiding this comment

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

LGTM

XadillaX pushed a commit that referenced this pull request Aug 10, 2017
@XadillaX
doc: add docs for AssertionError
4796fbc 
Fixes: #12274
PR-URL: #14261
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
@XadillaX
Copy link
Contributor

XadillaX commented Aug 10, 2017 •
edited
Loading

Landed in 4796fbc.

Congratulations and thanks for your first contribution!

Before: image

After: image

@XadillaX XadillaX closed this Aug 10, 2017
@daxlab daxlab deleted the issue_12274 branch August 10, 2017 14:00
addaleax pushed a commit that referenced this pull request Aug 10, 2017
@addaleax
doc: add docs for AssertionError
d3b0722 
Fixes: #12274
PR-URL: #14261
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
@addaleax addaleax mentioned this pull request Aug 13, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gibfahn gibfahn gibfahn approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@tniessen tniessen tniessen approved these changes

@XadillaX XadillaX XadillaX approved these changes

@cjihrig cjihrig cjihrig approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
assert Issues and PRs related to the assert subsystem. doc Issues and PRs related to the documentations. errors Issues and PRs related to JavaScript errors originated in Node.js core.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@daxlab @vsemozhetbyt @XadillaX @jasnell @cjihrig @tniessen @gibfahn @MylesBorins @nodejs-github-bot