Skip to content

Commit 88aee8a

Browse files
TrottMylesBorins
authored andcommitted
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: #20788 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent d614511 commit 88aee8a

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

COLLABORATOR_GUIDE.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,11 @@ recommended but not required.
411411

412412
### Deprecations
413413

414-
**Deprecation** refers to the identification of Public APIs that should no
415-
longer be used.
414+
[_Deprecation_][] is "the discouragement of use of some … feature … or practice,
415+
typically because it has been superseded or is no longer considered efficient or
416+
safe, without completely removing it or prohibiting its use. It can also imply
417+
that a feature, design, or practice will be removed or discontinued entirely in
418+
the future."
416419

417420
Node.js uses three Deprecation levels:
418421

@@ -879,6 +882,7 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.
879882
[Enhancement Proposal]: https://github.com/nodejs/node-eps
880883
[Stability Index]: doc/api/documentation.md#stability-index
881884
[TSC]: https://github.com/nodejs/TSC
885+
[_Deprecation_]: https://en.wikipedia.org/wiki/Deprecation
882886
[`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation
883887
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
884888
[backporting guide]: doc/guides/backporting-to-release-lines.md

0 commit comments

Comments
 (0)