doc: document missing error codes#15160
Closed
gnbezerra wants to merge 1 commit intonodejs:masterfrom
gnbezerra:fix-internal-errors-docs
Closed
doc: document missing error codes#15160gnbezerra wants to merge 1 commit intonodejs:masterfrom gnbezerra:fix-internal-errors-docs
gnbezerra wants to merge 1 commit intonodejs:masterfrom
gnbezerra:fix-internal-errors-docs
Conversation
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
added
doc
Member
|
I'm not sure it's preferably to say who is using an error rather than what is represents. |
jasnell
approved these changes
Sep 5, 2017
Member
jasnell
left a comment
jasnell
left a comment
There was a problem hiding this comment.
LGTM as is to get these documented. We'll need to go back and improve all of the descriptions later any way.
Member
|
ping @benjamingr .. are you good with this as is? We can go back and make further improvements separately |
Member
|
Not blocking this - feel free to land |
Member
|
Landed in 1cdb41f |
Member
|
@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>
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>
Contributor
|
ping re backport |
2 tasks
Member
|
@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>
Merged
Member
|
Why did this remove |
4 tasks
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>
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
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There are discrepancies between the errors defined in
lib/internal/errors.jsand those documented indoc/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