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.

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

doc: document missing error codes #15160

Closed
wants to merge 1 commit into from
Closed

doc: document missing error codes #15160

wants to merge 1 commit into from

Conversation

gnbezerra
Copy link
Contributor

There are discrepancies between the errors defined in
lib/internal/errors.js and those documented in doc/api/errors.md.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

Fixes: #15038

Checklist
Affected core subsystem(s)

doc

There are discrepancies between the errors defined in
`lib/internal/errors.js` and those documented in `doc/api/errors.md`.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

Fixes: #15038
@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 Sep 3, 2017
@benjamingr
Copy link
Member

I'm not sure it's preferably to say who is using an error rather than what is represents.

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

LGTM as is to get these documented. We'll need to go back and improve all of the descriptions later any way.

@jasnell
Copy link
Member

jasnell commented Sep 7, 2017

ping @benjamingr .. are you good with this as is? We can go back and make further improvements separately

@benjamingr
Copy link
Member

Not blocking this - feel free to land

@BridgeAR
Copy link
Member

BridgeAR commented Sep 8, 2017

Landed in 1cdb41f

@BridgeAR BridgeAR closed this Sep 8, 2017
@BridgeAR
Copy link
Member

BridgeAR commented Sep 8, 2017

@gnbezerra Thanks a lot for your contribution and congratulations on your first commit to Node.js!

BridgeAR pushed a commit that referenced this pull request Sep 8, 2017
There are discrepancies between the errors defined in
`lib/internal/errors.js` and those documented in `doc/api/errors.md`.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

PR-URL: #15160
Fixes: #15038
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins
Copy link
Contributor

This does not land cleanly on v8.x-staging. is it relevant for an 8.x release? If so could we backport?

addaleax pushed a commit to addaleax/node that referenced this pull request Sep 13, 2017
There are discrepancies between the errors defined in
`lib/internal/errors.js` and those documented in `doc/api/errors.md`.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

PR-URL: nodejs#15160
Fixes: nodejs#15038
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins
Copy link
Contributor

ping re backport

@lance
Copy link
Member

lance commented Oct 27, 2017

@MylesBorins I have backported this here: #16556

gibfahn pushed a commit that referenced this pull request Oct 30, 2017
There are discrepancies between the errors defined in
`lib/internal/errors.js` and those documented in `doc/api/errors.md`.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

PR-URL: #15160
Backport-PR-URL: #16556
Fixes: #15038
Reviewed-By: James M Snell <jasnell@gmail.com>
gibfahn pushed a commit that referenced this pull request Oct 31, 2017
There are discrepancies between the errors defined in
`lib/internal/errors.js` and those documented in `doc/api/errors.md`.
Some of the errors recently defined are not documented, while others
were removed, but still have entries in the docs. This commit fills in
those gaps in the documentation.

PR-URL: #15160
Backport-PR-URL: #16556
Fixes: #15038
Reviewed-By: James M Snell <jasnell@gmail.com>
@gibfahn gibfahn mentioned this pull request Oct 31, 2017
@ChALkeR
Copy link
Member

ChALkeR commented Jun 21, 2018

Why did this remove ERR_HTTP2_ERROR and ERR_UNKNOWN_BUILTIN_MODULE?
See #21440 (comment).

ChALkeR added a commit to ChALkeR/io.js that referenced this pull request Jun 24, 2018
ERR_HTTP2_ERROR and ERR_UNKNOWN_BUILTIN_MODULE error codes documentation
seem to have been accidentally removed in commit
1cdb41f (pull request nodejs#15160).

This reverts that removal, restoring the documentation for those two
error codes.

Those error codes are used from lib/ folder.

This is a part of the fixes hinted by nodejs#21470, which includes some tests
for error codes usage and documentation and enforces a stricter format.

PR-URL: nodejs#21484
Refs: nodejs#21470
Refs: nodejs#21440
Refs: nodejs#15160
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
targos pushed a commit that referenced this pull request Jun 24, 2018
ERR_HTTP2_ERROR and ERR_UNKNOWN_BUILTIN_MODULE error codes documentation
seem to have been accidentally removed in commit
1cdb41f (pull request #15160).

This reverts that removal, restoring the documentation for those two
error codes.

Those error codes are used from lib/ folder.

This is a part of the fixes hinted by #21470, which includes some tests
for error codes usage and documentation and enforces a stricter format.

PR-URL: #21484
Refs: #21470
Refs: #21440
Refs: #15160
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Discrepancies between error list and documentation
8 participants