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.

Sign up for GitHub

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

Jump to bottom

doc: improve --pending-deprecation documentation #18433

Merged
merged 2 commits into from
Jan 30, 2018
Merged

doc: improve --pending-deprecation documentation #18433

merged 2 commits into from
Jan 30, 2018

Conversation

ChALkeR
Copy link
Member

@ChALkeR ChALkeR 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

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 29, 2018
@ChALkeR ChALkeR requested review from jasnell and a team January 29, 2018 17:34
@ChALkeR ChALkeR force-pushed the document-pending-deprecation branch from 57dd581 to 4b7187c Compare January 29, 2018 17:36
@ChALkeR ChALkeR mentioned this pull request Jan 29, 2018
Closed
@ChALkeR ChALkeR force-pushed the document-pending-deprecation branch from 4b7187c to f93e3bb Compare January 29, 2018 18:01
@ChALkeR
doc: add pending-deprecation to COLLABORATOR_GUIDE
c276851 
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>
@ChALkeR
doc: add pending-deprecation to deprecations list
4efde4d 
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>
@ChALkeR ChALkeR force-pushed the document-pending-deprecation branch from f93e3bb to 4efde4d Compare January 30, 2018 22:23
@ChALkeR ChALkeR merged commit 4efde4d into nodejs:master Jan 30, 2018
@ChALkeR
Copy link
Member Author

ChALkeR commented Jan 30, 2018

Landed in e56189e...4efde4d.

This was referenced Jan 30, 2018
Closed
Closed
@addaleax addaleax mentioned this pull request Feb 9, 2018
Closed
2 tasks
@MylesBorins
Copy link
Contributor

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 pushed a commit that referenced this pull request Feb 20, 2018
@ChALkeR @MylesBorins
doc: add pending-deprecation to COLLABORATOR_GUIDE
8dc159d 
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 pushed a commit that referenced this pull request Feb 21, 2018
@ChALkeR @MylesBorins
doc: add pending-deprecation to COLLABORATOR_GUIDE
99cbe44 
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 pushed a commit that referenced this pull request Feb 21, 2018
@ChALkeR @MylesBorins
doc: add pending-deprecation to COLLABORATOR_GUIDE
8a627b1 
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 mentioned this pull request Feb 21, 2018
Merged
@addaleax addaleax mentioned this pull request Feb 26, 2018
Closed
4 tasks
addaleax pushed a commit to addaleax/node that referenced this pull request Feb 27, 2018
@ChALkeR @addaleax
doc: add pending-deprecation to deprecations list
dd917eb 
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 mentioned this pull request Feb 27, 2018
Closed
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@ChALkeR @MayaLekova
doc: add pending-deprecation to COLLABORATOR_GUIDE
301e3ad 
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 pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@ChALkeR @MayaLekova
doc: add pending-deprecation to deprecations list
d8bbf56 
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
Reviewers

@danbev danbev danbev approved these changes

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@ChALkeR @MylesBorins @danbev @jasnell @Trott @addaleax @lpinca @cjihrig @targos @nodejs-github-bot