-
Notifications
You must be signed in to change notification settings - Fork 47.2k
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
Tweak comment wording #18007
Tweak comment wording #18007
Conversation
This reverts commit b63cb6f.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure reverting is the best case here. I think we should revise the comment to be clearer. Happy to discuss offline.
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:
|
"Subtract from the offset" should be clearer and reflects what the code is doing. |
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_OFFSET
is still being added, not subtracted.A - B
does 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.