doc: add a missing anchor to error codes #21483
Merged
Conversation
This file contains 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
ChALkeR
added
doc
nodejs-github-bot
added
doc
|
This error code was introduced in 3152b7c, /cc @joyeecheung. #20147 which added this error code is semver-major, so this should land only on |
joyeecheung
approved these changes
Jun 23, 2018
ChALkeR
added
the
author ready
vsemozhetbyt
approved these changes
Jun 23, 2018
cjihrig
approved these changes
Jun 23, 2018
3 tasks
trivikr
approved these changes
Jun 23, 2018
lpinca
approved these changes
Jun 23, 2018
|
👍 on this comment for fast-track (sorry for not mentioning it earlier). |
targos
approved these changes
Jun 24, 2018
ChALkeR
force-pushed
the
doc-errcodes-references
branch
from
aab4d5c to
e49ecd7
Compare
Only one error code was missing an appropriate anchor, and it was ERR_SCRIPT_EXECUTION_TIMEOUT. This commit adds that missing anchor. 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#21483 Refs: nodejs#21470 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@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>
ChALkeR
force-pushed
the
doc-errcodes-references
branch
from
e49ecd7 to
baca6d3
Compare
|
Landed in baca6d3, thanks! |
ChALkeR
added a commit
to ChALkeR/io.js
that referenced
this pull request
Sep 8, 2018
This adds several sanity checks for error codes.
It scans:
* all natives (js sources),
* doc/api/*.md documentation
* src/node_errors.h (errors definition from the C++ side).
There is also a whitelist of manually created errors from JS side,
currently consisting of ERR_HTTP2_ERROR and ERR_UNKNOWN_BUILTIN_MODULE.
Alsom all ERR_NAPI_ codes are whitelisted, as those are created directly
on the cpp side, without declaring them first.
The performed checks:
1. All errors used from JS should be defined in `internal/errors` and
present in its .codes object. Whitelist (mentioned above) applies.
2. All errors instantiated from JS without arguments should support
0-arguments version.
3. All errors mentioned in doc should defined either in JS, C++, or
in the whitelist.
4. All errors mentioned anywhere should be documented.
5. Documentation of error codes should be sorted, have no repeats,
and include exactly one entry for every error code mentioned in
the documentation, formatted as `/\n### (ERR_[A-Z0-9_]+)\n`.
6. All doc entries for error codes should have appropriate anchors.
There is also a --report flag, which prints all the current issues and
exits without asserting, for manual inspection.
Individual fixes for those issues are landed in separate commits.
Refs: nodejs#21421
Refs: nodejs#21440
Refs: nodejs#21483
Refs: nodejs#21484
Refs: nodejs#21485
Refs: nodejs#21487
PR-URL: nodejs#21470
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Only one error code was missing an appropriate anchor, and it was
ERR_SCRIPT_EXECUTION_TIMEOUT.This commit adds that missing anchor.
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.
I split this into a separate commit/PR as this should be easy to land (and backport if needed), and some of the other fixes are more heavy and/or controversial.
Refs: #21470, #21440
Tests are not included — #21470 does that.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes