-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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
Discrepancies between error list and documentation #15038
Comments
@maclover7 thank you for doing this! /cc @jasnell |
Is this good for a first PR, I guess? Correct me if I'm wrong. Anyway, I'll try to submit a PR by tomorrow updating the errors in the documentation. Edit: taking a bit more time than I expected due to other obligations, but I'm still on it. |
About the list @maclover7 compiled, just a few corrections to it:
Oh, and thank you for calling attention to this issue, @maclover7! |
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>
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>
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>
There are a few discrepancies between the errors defined in
lib/internal/errors.js
and those appearing in the documentation indoc/api/errors.md
. The differences are outlined below (I compiled this list manually, and it's possible some errors are missing -- please comment if so!!), and this should be fairly straightforward to solve -- people would just need to submit PRs to fill in the missing documentation :)cc @Trott
yes
lib/internal/errors.js
, nodoc/api/errors.md
no
lib/internal/errors.js
, yesdoc/api/errors.md
Something else to consider is how to prevent this from happening in the future. I've been playing around with some ESLint stuff, but would appreciate people's thoughts on this.
The text was updated successfully, but these errors were encountered: