From fd650033cfe501a68b24e667caf88983a6bf4731 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 16 May 2018 14:24:11 -0700 Subject: [PATCH 1/2] doc: improve _Deprecation_ definition * Use definition from Wikipedia. Provide link. * Use italics for "words-as-words". * Simplify sentence. ("Deprecation is..." rather than "Deprecation refers to...".) --- COLLABORATOR_GUIDE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 585d102f73ef35..750f760fc5afca 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -411,8 +411,11 @@ recommended but not required. ### Deprecations -**Deprecation** refers to the identification of Public APIs that should no -longer be used. +[_Deprecation_] is "the discouragement of use of some…feature…or practice, +typically because it has been superseded or is no longer considered efficient or +safe, without completely removing it or prohibiting its use. It can also imply +that a feature, design, or practice will be removed or discontinued entirely in +the future." Node.js uses three Deprecation levels: @@ -879,6 +882,7 @@ If you cannot find who to cc for a file, `git shortlog -n -s ` may help. [Enhancement Proposal]: https://github.com/nodejs/node-eps [Stability Index]: doc/api/documentation.md#stability-index [TSC]: https://github.com/nodejs/TSC +[_Deprecation_]: https://en.wikipedia.org/wiki/Deprecation [`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation [`node-core-utils`]: https://github.com/nodejs/node-core-utils [backporting guide]: doc/guides/backporting-to-release-lines.md From 4fe5c92db30a6f07c4fbcd61782dc7c8c7b9942a Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 18 May 2018 22:45:40 -0700 Subject: [PATCH 2/2] squash! tniessen comments --- COLLABORATOR_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 750f760fc5afca..f5ffd35f04aa02 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -411,7 +411,7 @@ recommended but not required. ### Deprecations -[_Deprecation_] is "the discouragement of use of some…feature…or practice, +[_Deprecation_][] is "the discouragement of use of some … feature … or practice, typically because it has been superseded or is no longer considered efficient or safe, without completely removing it or prohibiting its use. It can also imply that a feature, design, or practice will be removed or discontinued entirely in