FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add docs for AssertionError by daxlab · Pull Request #14261 · nodejs/node · GitHub

/ node Public

doc: add docs for AssertionError - #14261

Closed
daxlab wants to merge 2 commits into
nodejs:masterfrom
daxlab:issue_12274
Closed

doc: add docs for AssertionError#14261
daxlab wants to merge 2 commits into
nodejs:masterfrom
daxlab:issue_12274

Conversation

daxlab commented Jul 16, 2017
edited
Loading

Copy link
Copy Markdown
Contributor
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 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 commented Jul 16, 2017
edited
Loading

Copy link
Copy Markdown
Contributor

Thank you!

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

vsemozhetbyt added the assert Issues and PRs related to the assert subsystem. label Jul 16, 2017
Comment thread doc/api/errors.md Outdated
For example:

```js
assert.equal(1, 2);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread 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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

XadillaX left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM

XadillaX pushed a commit that referenced this pull request Aug 10, 2017
Fixes: #12274
PR-URL: #14261
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>

XadillaX commented Aug 10, 2017
edited
Loading

Copy link
Copy Markdown
Contributor

Landed in 4796fbc.

Congratulations and thanks for your first contribution!

Before:

After:

XadillaX closed this Aug 10, 2017
daxlab deleted the issue_12274 branch August 10, 2017 14:00
addaleax pushed a commit that referenced this pull request Aug 10, 2017
Fixes: #12274
PR-URL: #14261
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
addaleax mentioned this pull request Aug 13, 2017
This file contains hidden or 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

9 participants


Back | FazBrowse Home | New Git URL