Skip to content

doc: improve _Deprecation_ definition #20788

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

Closed
Trott wants to merge 2 commits into from
Closed

doc: improve _Deprecation_ definition #20788

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd65003
doc: improve _Deprecation_ definition
Trott May 16, 2018
4fe5c92
squash! tniessen comments
Trott May 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
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...".)
  • Loading branch information
@Trott
Trott committed May 19, 2018
commit fd650033cfe501a68b24e667caf88983a6bf4731
8 changes: 6 additions & 2 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Copy link
Copy Markdown
Member

@tniessen tniessen May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between [_Deprecation_] and [_Deprecation_][]? I have seen both versions, but mostly the latter.

Copy link
Copy Markdown
Member Author

@Trott Trott May 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd not noticed that the former worked. I meant to do the latter but made a mistake. I'll fix that.

Copy link
Copy Markdown
Member

@tniessen tniessen May 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it common practice to omit spaces when using an ellipsis in English? (In German, it is not.)

Copy link
Copy Markdown
Member Author

@Trott Trott May 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Judging from https://en.wikipedia.org/wiki/Ellipsis#In_American_English, practices vary. I'll add spaces on both sides of each ellipsis.

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:

Expand Down Expand Up @@ -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
Expand Down