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

Tweak comment wording #18007

Merged
merged 2 commits into from
Feb 10, 2020
Merged

Tweak comment wording #18007

merged 2 commits into from
Feb 10, 2020

Conversation

gaearon
Copy link
Collaborator

@gaearon gaearon commented Feb 10, 2020

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 "subtract A".

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.

@facebook-github-bot facebook-github-bot added CLA Signed React Core Team Opened by a member of the React Core Team labels Feb 10, 2020
Copy link
Contributor

@trueadm trueadm left a 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.

@codesandbox-ci
Copy link

codesandbox-ci bot commented 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:

Sandbox Source
wispy-sound-cj7fw Configuration

@sizebot
Copy link

sizebot commented Feb 10, 2020

No significant bundle size changes to report.

Size changes (experimental)

Generated by 🚫 dangerJS against 2513983

@sizebot
Copy link

sizebot commented Feb 10, 2020

No significant bundle size changes to report.

Size changes (stable)

Generated by 🚫 dangerJS against 2513983

@gaearon
Copy link
Collaborator Author

gaearon commented Feb 10, 2020

"Subtract from the offset" should be clearer and reflects what the code is doing.

@gaearon gaearon changed the title Revert "Grammar fix" Tweak comment wording Feb 10, 2020
@gaearon gaearon merged commit 517de74 into master Feb 10, 2020
@kassens kassens deleted the revert-17825-grammar-fix branch November 29, 2022 22:19
@kassens kassens restored the revert-17825-grammar-fix branch November 29, 2022 22:19
@kassens kassens deleted the revert-17825-grammar-fix branch November 29, 2022 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed React Core Team Opened by a member of the React Core Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants