-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Renamed add_plugins to add_plugin_group to be more clear #7643
Conversation
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
This looks correct :) That said, for such a simple but noisy change, it would be nice to add a deprecation warning. To do so:
See https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute for more details. |
Yep, we'll need to be careful to check that the version number of the depreciation matches when we actually ship this. |
@cart I've requested your review because I know you're going to have opinions on this change. My arguments are:
|
Co-authored-by: François <[email protected]>
Hmmmm here are my counter arguments:
|
Mostly agreed on 1 and 2. 3 I think applies just as well to 4 is the most compelling to me. If we had the ability to customize error messages to improve this footgun I'd happily close this out. Actually, let me see if we could improve these diagnostics upstream in Rust... |
Not quite as well. We'd need to rename |
Closing in tandem with #7631 |
This is my first PR so please let me know if I'm doing something incorrectly. This touches quite a few files, but it's largely just renaming the add_plugins function.
That being said, would we favor deprecating usage of add_plugins somehow (such as emitting a warning if possible?) instead of just removing it outright? Let me know if that's more desirable and I can change this PR.
@alice-i-cecile FYI!
Objective
App::add_plugins
toApp::add_plugin_group
#7631Solution
Migration Guide
-Users will have to change all usages of add_plugins to add_plugin_group in order to compile without warnings.