Skip to content

doc: remove stability from unreleased errors - #33764

Merged
Trott merged 0 commit into
nodejs:masterfrom
Trott:error-stability
Jul 4, 2020
Merged

doc: remove stability from unreleased errors#33764
Trott merged 0 commit into
nodejs:masterfrom
Trott:error-stability

Conversation

@Trott

@TrottTrott commented Jun 6, 2020

Copy link
Copy Markdown
Member

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-botnodejs-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

Trott commented Jun 8, 2020

Copy link
Copy Markdown
MemberAuthor

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
Copy Markdown
Member

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

@Trott

Trott commented Jul 3, 2020

Copy link
Copy Markdown
MemberAuthor

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

@addaleaxaddaleax left a comment

Copy link
Copy Markdown
Member

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
Copy Markdown
Member

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.

@TrottTrott closed this Jul 4, 2020
@Trott
Trott merged commit 21005c3 into nodejs:masterJul 4, 2020
@Trott

Trott commented Jul 4, 2020

Copy link
Copy Markdown
MemberAuthor

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 <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
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 <anna@addaleax.net>
MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
Refs: #33764 (comment)
PR-URL: #34197
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorinsMylesBorins 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 <anna@addaleax.net>
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
Refs: #33764 (comment)
PR-URL: #34197
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
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 <anna@addaleax.net>
codebytere pushed a commit that referenced this pull request Sep 27, 2020
Refs: #33764 (comment)
PR-URL: #34197
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
addaleax pushed a commit that referenced this pull request Sep 28, 2020
Refs: #33764 (comment)
PR-URL: #34197
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.errorsIssues 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

@Trott@jasnell@addaleax@nodejs-github-bot