doc: avoid _may_ in collaborator guide#34749
Closed
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
jvmazagao approved these changes Aug 12, 2020
jasnell approved these changes Aug 12, 2020
Member
jasnell left a comment
jasnell left a comment There was a problem hiding this comment.
It's going to be very difficult to change this spec author's habits with regards to using "may" ......
Leko approved these changes Aug 12, 2020
MemberAuthor
Trott commented Aug 12, 2020
Rebased to resolve conflicts and force-pushed. |
trivikr approved these changes Aug 13, 2020
antsmartian approved these changes Aug 13, 2020
lpinca approved these changes Aug 13, 2020
rickyes added the author ready MemberAuthor
Trott commented Aug 14, 2020
I think you mean to say:
|
MemberAuthor
Trott commented Aug 14, 2020
Landed in 8640cd6 |
Trott added a commit that referenced this pull request Aug 14, 2020
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Aug 17, 2020
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Merged
BethGriggs pushed a commit that referenced this pull request Aug 20, 2020
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
Many style guides (including Microsoft's) suggest avoiding _may_ because it can be unclear. Using _can_ or _might_ tends to increase clarity. An example in this change: > They may not change to a Runtime Deprecation until the next major > release. It's not clear if that means "They can not change until the next major release" or "They might not change until the next major release but also might change before then". Using _can_ or _might_ instead of _may_ clears up the ambiguity. Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may PR-URL: #34749 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Shingo Inoue <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Many style guides (including Microsoft's) suggest avoiding may because
it can be unclear. Using can or might tends to increase clarity.
An example in this change:
It's not clear if that means "They can not change until the next major
release" or "They might not change until the next major release but also
might change before then". Using can or might instead of may
clears up the ambiguity.
Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/can-may
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes