Skip to content
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

Jump to bottom

doc: improve _Deprecation_ definition #20788

Closed
wants to merge 2 commits into from
Closed

doc: improve _Deprecation_ definition #20788

wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented May 16, 2018 •
edited
Loading

  • Use definition from Wikipedia. Provide link.
  • Use italics for "words-as-words".
  • Simplify sentence. ("Deprecation is..." rather than "Deprecation refers
    to...".)
Checklist

@Trott Trott requested a review from a team as a code owner May 16, 2018 21:29
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 16, 2018
@Trott
Copy link
Member Author

Trott commented May 16, 2018

Refs: https://github.com/nodejs/node/pull/20523/files#r186261530

@BridgeAR @mcollina

@Trott
Copy link
Member Author

Trott commented May 16, 2018

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/723/

@trivikr trivikr mentioned this pull request May 17, 2018
Closed
2 tasks
@richardlau
Copy link
Member

Use definition from Wikipedia. Provide link.

The definition and linked page looks to be under Creative Commons Attribution-ShareAlike 3.0 which has conditions of use. The quoted text appears to originate in http://openjdk.java.net/jeps/277.

@Trott
Copy link
Member Author

Trott commented May 17, 2018 •
edited
Loading

The definition and linked page looks to be under Creative Commons Attribution-ShareAlike 3.0 which has conditions of use. The quoted text appears to originate in http://openjdk.java.net/jeps/277.

@richardlau From the license:

You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.

This is certainly an "applicable exception or limitation", specifically fair use. We are quoting less than two sentences. Fair use is one of the enumerated exceptions in the license FAQ.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 17, 2018
@Trott
Copy link
Member Author

Trott commented May 18, 2018

Rebased to eliminate conflict and force-pushed.

LIte CI: https://ci.nodejs.org/job/node-test-pull-request-lite/727/

tniessen
tniessen reviewed May 18, 2018
View reviewed changes
COLLABORATOR_GUIDE.md Outdated
@@ -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
Member

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
Member Author

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.

COLLABORATOR_GUIDE.md Outdated
@@ -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
Member

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
Member Author

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.

Trott added 2 commits May 18, 2018 22:44
@Trott
doc: improve _Deprecation_ definition
fd65003 
* Use definition from Wikipedia. Provide link.
* Use italics for "words-as-words".
* Simplify sentence. ("Deprecation is..." rather than "Deprecation refers
  to...".)
@Trott
squash! tniessen comments
4fe5c92
@Trott
Copy link
Member Author

Trott commented May 19, 2018

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/729/

Trott added a commit to Trott/io.js that referenced this pull request May 20, 2018
@Trott
doc: improve _Deprecation_ definition
df511c6 
* Use definition from Wikipedia. Provide link.
* Use italics for "words-as-words".
* Simplify sentence. ("Deprecation is..." rather than "Deprecation
  refers to...".)

PR-URL: nodejs#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>
@Trott
Copy link
Member Author

Trott commented May 20, 2018

Landed in df511c6

@Trott Trott closed this May 20, 2018
MylesBorins pushed a commit that referenced this pull request May 22, 2018
@Trott @MylesBorins
doc: improve _Deprecation_ definition
88aee8a 
* 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 <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>
@addaleax addaleax mentioned this pull request May 22, 2018
Merged
@richardlau richardlau mentioned this pull request Feb 17, 2019
Closed
3 tasks
@Trott Trott deleted the deprecation-definition branch January 13, 2022 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@richardlau richardlau richardlau approved these changes

@tniessen tniessen tniessen approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@Trott @richardlau @jasnell @lpinca @cjihrig @tniessen @trivikr @nodejs-github-bot