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: improve `--pending-deprecation` documentation #18433

Merged
merged 2 commits into from Jan 30, 2018

Conversation

Projects
None yet
10 participants
@ChALkeR
Copy link
Member

commented Jan 29, 2018

This implements steps 1-2 from #18417:

  1. --pending-deprecation is being mentioned in COLLABORATOR_GUIDE.md#deprecations as a subset of doc-deprecation.
  2. --pending-deprecation is being mentioned in doc/api/deprecations.md, and the deprecations that support it are explicitly labeled as such (currently, there is only one).
Checklist
  • make lint-md passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@ChALkeR ChALkeR requested review from jasnell and nodejs/tsc Jan 29, 2018

@ChALkeR ChALkeR force-pushed the ChALkeR:document-pending-deprecation branch from 57dd581 to 4b7187c Jan 29, 2018

@ChALkeR ChALkeR force-pushed the ChALkeR:document-pending-deprecation branch from 4b7187c to f93e3bb Jan 29, 2018

@lpinca

lpinca approved these changes Jan 29, 2018

@danbev

danbev approved these changes Jan 30, 2018

@Trott

Trott approved these changes Jan 30, 2018

ChALkeR added some commits Jan 29, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: #18417
PR-URL: #18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: #18417
PR-URL: #18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@ChALkeR ChALkeR force-pushed the ChALkeR:document-pending-deprecation branch from f93e3bb to 4efde4d Jan 30, 2018

@ChALkeR ChALkeR merged commit 4efde4d into nodejs:master Jan 30, 2018

@ChALkeR

This comment has been minimized.

Copy link
Member Author

commented Jan 30, 2018

Landed in e56189e...4efde4d.

kcaulfield94 added a commit to kcaulfield94/node that referenced this pull request Feb 2, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

kcaulfield94 added a commit to kcaulfield94/node that referenced this pull request Feb 2, 2018

doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 5, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 5, 2018

doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@addaleax addaleax referenced this pull request Feb 9, 2018

Closed

doc: more stability guarantees in deprecation policy #18682

2 of 2 tasks complete
@MylesBorins

This comment has been minimized.

Copy link
Member

commented Feb 20, 2018

Should this be backported to v9.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

MylesBorins added a commit that referenced this pull request Feb 20, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: #18417
PR-URL: #18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

MylesBorins added a commit that referenced this pull request Feb 21, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: #18417
PR-URL: #18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

MylesBorins added a commit that referenced this pull request Feb 21, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: #18417
PR-URL: #18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@MylesBorins MylesBorins referenced this pull request Feb 21, 2018

Merged

v9.6.0 proposal #18902

@addaleax addaleax referenced this pull request Feb 26, 2018

Closed

process: doc-only deprecate non-string env value #18990

4 of 4 tasks complete

addaleax added a commit to addaleax/node that referenced this pull request Feb 27, 2018

doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@addaleax addaleax referenced this pull request Feb 27, 2018

Closed

v9.7.0 proposal #19040

MayaLekova added a commit to MayaLekova/node that referenced this pull request May 8, 2018

doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

MayaLekova added a commit to MayaLekova/node that referenced this pull request May 8, 2018

doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.

Refs: nodejs#18417
PR-URL: nodejs#18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.