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: remove stability from unreleased errors #33764

Merged
merged 0 commits into from
Jul 4, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Jun 6, 2020

Remove stability indicators from errors that only existed on the master
branch and are not in the release.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@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 Jun 6, 2020
@Trott
Copy link
Member Author

Trott commented Jun 8, 2020

These two errors are in the "Other error codes" section indicating they have never been released. They are listed here only because they had been on the master branch at some point. Not sure who to ping for reviews....

@jasnell
Copy link
Member

jasnell commented Jul 3, 2020

If the error codes are not being used, they should just be removed entirely.

@Trott
Copy link
Member Author

Trott commented Jul 3, 2020

If the error codes are not being used, they should just be removed entirely.

I can't find where it's documented right now (so maybe it's not?) but my impression was that any error code that ever appeared in a release--even a nightly!--could never be removed from the documentation. In fact, I thought you were the one that originated that policy! But again, I can't find it anywhere, so maybe I'm wrong on all counts. (Maybe I'm confusing it with deprecation codes?)

Regardless, I'd be for removing unused error codes.

/ping @addaleax

Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

I don’t have a strong opinion, but I do like that we keep the error codes around that were released but removed in a later release.

@jasnell
Copy link
Member

jasnell commented Jul 4, 2020

Released, then removed is one thing. There needs to be a section for defunct error codes if there isn't already. But if the code was never in a release and is never used, it should be removed.

@Trott Trott closed this Jul 4, 2020
@Trott Trott merged commit 21005c3 into nodejs:master Jul 4, 2020
@Trott
Copy link
Member Author

Trott commented Jul 4, 2020

Landed in 21005c3. I'll open a PR to remove these entirely now, but wanted to get the stability labels removed regardless in case that PR doesn't land.

@Trott Trott deleted the error-stability branch July 4, 2020 12:53
Trott added a commit to Trott/io.js that referenced this pull request Jul 6, 2020
jasnell pushed a commit that referenced this pull request Jul 6, 2020
Refs: #33764 (comment)

PR-URL: #34197
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
Remove stability indicators from errors that only existed on the master
branch and are not in the release.

PR-URL: #33764
Reviewed-By: Anna Henningsen <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
Refs: #33764 (comment)

PR-URL: #34197
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Jul 14, 2020
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
Remove stability indicators from errors that only existed on the master
branch and are not in the release.

PR-URL: #33764
Reviewed-By: Anna Henningsen <[email protected]>
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
Refs: #33764 (comment)

PR-URL: #34197
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
Remove stability indicators from errors that only existed on the master
branch and are not in the release.

PR-URL: #33764
Reviewed-By: Anna Henningsen <[email protected]>
codebytere pushed a commit that referenced this pull request Sep 27, 2020
Refs: #33764 (comment)

PR-URL: #34197
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 28, 2020
Refs: #33764 (comment)

PR-URL: #34197
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@codebytere codebytere mentioned this pull request Sep 28, 2020
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.

4 participants