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.

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

doc: for style, remove "isn't" contraction #10981

Merged
merged 1 commit into from
Jan 27, 2017

Conversation

sam-github
Copy link
Contributor

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@sam-github
Copy link
Contributor Author

@jasnell , re: #10968 (comment)

Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

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

Thank you :-)

@mscdex mscdex added the doc Issues and PRs related to the documentations. label Jan 25, 2017
@mscdex
Copy link
Contributor

mscdex commented Jan 25, 2017

I see the referenced comment, but why?

@sam-github
Copy link
Contributor Author

@jasnell question for you ----^ I am merely the typist. Helps my markdown plugin to avoid contractions, though :-)

@jasnell
Copy link
Member

jasnell commented Jan 27, 2017

Generally a style thing that makes reading through the docs easier, particularly for non-native English speakers.

Update: bit more on this. I recommend doing a quick google search for "non-native speakers" and "avoiding contractions". Many non-native speakers do not have a problem with contractions depending on their overall level of comfort with the language. However, contractions have historically been one of the more difficult aspects of English slang/colloquialism that are difficult for non-native speakers to master. The ones that always seem least likely to cause issues are things like "it's" or "I'll" as these are far more commonly used. That said, just consider how difficult it is for most native speakers to get "it's" and "its" correct.

@sam-github
Copy link
Contributor Author

been 3 days, two approvals, but @mscdex , did you object, or just want to know?

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@mscdex
Copy link
Contributor

mscdex commented Jan 27, 2017

@sam-github Not objecting, just wanted to know why.

PR-URL: nodejs#10981
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@sam-github sam-github merged commit 38161f0 into nodejs:master Jan 27, 2017
@sam-github sam-github deleted the do-not-use-isnt branch January 27, 2017 22:24
@sam-github
Copy link
Contributor Author

Thanks @mscdex, landed in 38161f0

evanlucas pushed a commit that referenced this pull request Jan 31, 2017
PR-URL: #10981
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@italoacasas italoacasas mentioned this pull request Jan 31, 2017
@jasnell
Copy link
Member

jasnell commented Mar 8, 2017

landed in v6. This would need a backport PR to land in v4

jasnell pushed a commit that referenced this pull request Mar 8, 2017
PR-URL: #10981
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
PR-URL: #10981
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@MylesBorins MylesBorins mentioned this pull request Mar 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants