daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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...".)

PR-URL: https://github.com/nodejs/node/pull/20788
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
pull/20842/head
Rich Trott 2018-05-16 14:24:11 -07:00
parent 1ae184a85c
commit df511c6195
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
COLLABORATOR_GUIDE.md
View File

@ -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 <file>` 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