-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
style(mixed): fix spelling and grammar issues in comments and tests #2196
Conversation
Mostly its/it's errors in this commit, along with a few verb number errors.
Codecov Report
@@ Coverage Diff @@
## master #2196 +/- ##
=======================================
Coverage 99.73% 99.73%
=======================================
Files 151 151
Lines 2611 2611
=======================================
Hits 2604 2604
Misses 7 7
Continue to review full report at Codecov.
|
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.
@direvus Thanks for your eyes 👍
@@ -29,7 +29,7 @@ export default class Ref extends Component { | |||
componentDidMount() { | |||
const { innerRef } = this.props | |||
|
|||
// Heads up! Don't move this condition, it's a short circle that avoids run of `findDOMNode` | |||
// Heads up! Don't move this condition, it's a short circuit that avoids run of `findDOMNode` |
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.
This one made me chuckle :)
Very cool, thanks much. There are quite a few of these in the code base and I'd love to clean them all up.... priorities! |
@levithomason You're very welcome! I spotted a couple of typos in the documentation and then went on a bit of a rampage. I've checked every instance of it's/its in the codebase, so I'm pretty confident that those are all correct (for now anyway). There were a fair number of code comments I came across that seemed non-idiomatic or strangely worded, but I was reluctant to fix those without a solid understanding of what each comment intends to say. If there are any other particular spelling/grammar errors you think might be widespread in the repo, feel free to let me know and I'll do a sweep. |
Awesome, I think the props doc blocks could use a sweep. As well as the Many of our contributors are non-native English speakers and awesome developers so I've consciously chosen not to slow them down for grammar's sake. However, a clean sweep over any of this would be super appreciated! |
Released in |
@levithomason No worries, I'll have a look soon. With the props doc blocks, does it make sense to change both the *.js and the *.d.ts files, or is one of these generated from the other? |
Unfortunately, we manage both manually. Please update both to match. |
This PR corrects some spelling and grammar errors in docs, code comments and example content.