doc: add full deprecation history#22766
Closed
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Even though the doc tool supports version arrays in theory, it fails to sort them properly causing the tool to crash.
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed.
nodejs-github-bot added doc 
vsemozhetbyt approved these changes Sep 9, 2018
Contributor
vsemozhetbyt left a comment
vsemozhetbyt left a comment There was a problem hiding this comment.
With nits)
Thank you for the heavy lifting.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
doc/api/deprecations.md Outdated
| <a id="DEP0097"></a> | ||
| ### DEP0097: MakeCallback with domain property | ||
| <!-- |
Uh oh!
There was an error while loading. Please reload this page.
doc/api/deprecations.md Outdated
| pr-url: https://github.com/nodejs/node/pull/10116 | ||
| description: A deprecation code has been assigned. | ||
| - version: | ||
| pr-url: |
MemberAuthor
tniessen commented Sep 10, 2018
Thanks for reviewing so thoroughly, @vsemozhetbyt! |
jasnell approved these changes Sep 10, 2018
MemberAuthor
BridgeAR approved these changes Sep 11, 2018
| changes: | ||
| - version: v10.0.0 | ||
| pr-url: https://github.com/nodejs/node/pull/19524 | ||
| description: Runtime deprecation. |
MemberAuthor
There was a problem hiding this comment.
Oh, sorry, must have missed the comment before landing :/ "partial" as in "not all occurrences will warn" or as in "only some variants of the constructor will warn"?
Member
There was a problem hiding this comment.
Not all occurrences will warn (ones that are in an npm module).
MemberAuthor
There was a problem hiding this comment.
Okay, mhhh I guess that's currently clear from the description, but it might be less obvious if that ever changes...
Member
There was a problem hiding this comment.
It should be fine. When deprecating it more it could be changed accordingly.
MemberAuthor
tniessen commented Sep 12, 2018
tniessen added a commit that referenced this pull request Sep 12, 2018
Even though the doc tool supports version arrays in theory, it fails to sort them properly causing the tool to crash. PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
tniessen added a commit that referenced this pull request Sep 12, 2018
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed. PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Sep 12, 2018
Even though the doc tool supports version arrays in theory, it fails to sort them properly causing the tool to crash. PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
Member
targos commented Sep 12, 2018
It would be awesome to have this in |
tniessen added a commit to tniessen/node that referenced this pull request Sep 12, 2018
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed. PR-URL: nodejs#22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
MemberAuthor
tniessen commented Sep 12, 2018
targos pushed a commit that referenced this pull request Sep 15, 2018
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed. Backport-PR-URL: #22826 PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Sep 19, 2018
Even though the doc tool supports version arrays in theory, it fails to sort them properly causing the tool to crash. PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Sep 19, 2018
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed. Backport-PR-URL: #22826 PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
targos pushed a commit that referenced this pull request Sep 20, 2018
I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier to find out when deprecations were introduced or changed. Backport-PR-URL: #22826 PR-URL: #22766 Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've had a hard time working with the deprecation documentation since it is currently lacking a history. Finding out when a deprecation was introduced or changed is difficult via Git and often impossible using our documentation alone. I think it is crucial to make the deprecation history transparent to users, so I tried to manually reconstruct the history of deprecations and to track them down to their origins. Having these documented publicly makes it much easier for users to find out when deprecations were introduced or changed, and it also helps us in maintaining Node.js.
The diff itself is large but will be low-maintenance once we start properly documenting these things. I also had to slightly fix the documentation tool to accept multiple versions for a single change. Note that some ancient versions might be slightly imprecise, tracking down deprecations from pre-io.js releases turned out to be difficult from time to time.
(This partially reverts #21498 in that it adds the removed documentation sections again and updates them to properly represent the history of these deprecations.)
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes