Tweak comment wording#18007
Merged
Merged
Conversation
This reverts commit b63cb6f.
trueadm
suggested changes
Feb 10, 2020
threepointone
approved these changes
Feb 10, 2020
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 2513983:
|
Collaborator
Author
|
"Subtract from the offset" should be clearer and reflects what the code is doing. |
trueadm
approved these changes
Feb 10, 2020
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Reverts #17825
I don't think this is a "grammar fix". This is a semantic change to what the comment says. It's misleading because the
MAGIC_NUMBER_OFFSETis still being added, not subtracted.A - Bdoes not mean "subtractA".In general, changing the meaning of comments should be done very carefully because misleading comments are especially dangerous. Ideally, it's best to double-check what the author meant.