-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Fix typos (RCTCustomRefreshControlProtocol) #36363
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
Fix typos (RCTCustomRefreshControlProtocol) #36363
Conversation
Base commit: 6c208c2 |
Hi @jiggag, thank you for this PR. Unfortunately, we cannot accept this as it is because changing a type that is widely used is a breaking change. If we release a version of React Native with just this change, we will break every project that uses this component. The proper way to go is:
Thank you so much for this! |
@@ -33,7 +33,7 @@ | |||
/** | |||
* Denotes a view which implements custom pull to refresh functionality. | |||
*/ | |||
@protocol RCTCustomRefreshContolProtocol | |||
@protocol RCTCustomRefreshControlProtocol |
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 is effectively a breaking change that adds really little value imho:
https://cs.github.com/?scopeName=All+repos&scope=&q=RCTCustomRefreshContolProtocol
I know the typo is not cool, but we can't just rename.
@cipolleschi what's your opinion on this?
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.
Oops I was late 😅 saw your comment above.
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.
As I said above. I will rename it, but not from one day to another.
I'll let the two protocols live for a couple of versions, so that users can be prompted on updating the naming and then we can remove it in 0.74 or 0.75, for example.
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.
@cipolleschi I'm not sure if what you suggested is documented or not, but your suggestion above is very informative at least in the context of renaming public APIs.
Provided typo-fix PRs are frequent, I suggest documenting your suggestions above in the Contributing Guide. Glad to open a PR (on react-native-website) for adding those suggestions. Lmk :)
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.
Hi @Pranav-yadav! That would be amazing, although I don't have a clear idea on where it should go.
Probably in the Contributing section of the Website? 🤔
To contribute to the website, you can work on the website repo. ;)
@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
/rebase |
1 similar comment
/rebase |
@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
e04030a
to
a8fee68
Compare
@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
@cipolleschi merged this pull request in 93c1fbd. |
Summary: Fix typo `RCTCustomRefreshContolProtocol` > `RCTCustomRefreshControlProtocol` ## Changelog [INTERNAL] [FIXED] - Fixed typo RCTCustomRefreshControlProtocol Pull Request resolved: facebook#36363 Test Plan: none Reviewed By: cortinico Differential Revision: D44024938 Pulled By: cipolleschi fbshipit-source-id: 1fbc4e75361334586e46e14ee746cbb94d230a92
Summary
Fix typo
RCTCustomRefreshContolProtocol
>RCTCustomRefreshControlProtocol
Changelog
[INTERNAL] [FIXED] - Fixed typo RCTCustomRefreshControlProtocol
Test Plan
none