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: use _can_ to describe actions in quic.md #34613

Closed
wants to merge 0 commits into from
Closed

doc: use _can_ to describe actions in quic.md #34613

wants to merge 0 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Aug 3, 2020

Per Microsoft style guide:

When ability is what you need to express, it's OK to use can to
describe actions or tasks that the reader or program is able to do.
Use might to express possibility. Don't use may, which might be
interpreted as providing permission.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may
Refs: #34353 (comment)

Checklist

@Trott Trott requested a review from a team August 3, 2020 16:29
@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. dont-land-on-v12.x quic Issues and PRs related to the QUIC implementation / HTTP/3. labels Aug 3, 2020
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 3, 2020
@jasnell jasnell added the fast-track PRs that do not need to wait for 48 hours to land. label Aug 4, 2020
@jasnell
Copy link
Member

jasnell commented Aug 4, 2020

fast-track? please 👍🏻

@Trott
Copy link
Member Author

Trott commented Aug 4, 2020

Landed in 3ea94ec...d5c7aec

Trott added a commit that referenced this pull request Aug 4, 2020
@Trott
doc: use _can_ to describe actions in quic.md
319c275 
Per Microsoft style guide:

> When ability is what you need to express, it's OK to use _can_ to
> describe actions or tasks that the reader or program is able to do.
> Use _might_ to express possibility. Don't use _may_, which might be
> interpreted as providing permission.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may
Refs: #34353 (comment)

PR-URL: #34613
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
Trott added a commit that referenced this pull request Aug 4, 2020
@Trott
doc: use _can_ to describe actions in quic.md
d5c7aec 
Per Microsoft style guide:

> When ability is what you need to express, it's OK to use _can_ to
> describe actions or tasks that the reader or program is able to do.
> Use _might_ to express possibility. Don't use _may_, which might be
> interpreted as providing permission.

Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may
Refs: #34353 (comment)

PR-URL: #34613
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gerhard Stöbich <[email protected]>
@Trott Trott closed this Aug 4, 2020
@Trott Trott deleted the brian-may branch August 4, 2020 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Flarna Flarna Flarna approved these changes

@aymen94 aymen94 aymen94 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. fast-track PRs that do not need to wait for 48 hours to land. quic Issues and PRs related to the QUIC implementation / HTTP/3.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Trott @nodejs-github-bot @jasnell @lpinca @aymen94 @Flarna