Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
MNT: Cleanup docstring substitution mechanisms#28795
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
149e3a0 toaf24473Compare62dcafa to66c2048Compare66c2048 to3a6901dCompareMemberAuthor
timhoffm commentedSep 9, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Possible future improvement: One could still rename |
3a6901d to3a319eeCompare5 tasks
3a319ee to4e2b127CompareQuLogic approved these changesSep 21, 2024
Uh oh!
There was an error while loading.Please reload this page.
They do not have relevant functional overlap. Thus, it's simplerto keep them completely separated.
While it's internally a dict.update. The logical process is aregistration to make the names publically available. Also,remove the possibility to pass a dict. Passing kwargs isenough and we can simplify the API to only one type of usage.
4e2b127 tofe9479aCompare24c5048 intomatplotlib:main 41 of 43 checks passed
Uh oh!
There was an error while loading.Please reload this page.
kyracho pushed a commit to kyracho/matplotlib that referenced this pull requestOct 10, 2024
* MNT: Make Substitution and _ArtistPropertiesSubstitution independentThey do not have relevant functional overlap. Thus, it's simplerto keep them completely separated.* Rename _ArtistPropertiesSubstitution.update() to register()While it's internally a dict.update. The logical process is aregistration to make the names publically available. Also,remove the possibility to pass a dict. Passing kwargs isenough and we can simplify the API to only one type of usage.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
Inspired by#28746.
Since the module
_docstringis internal, we can do this refactoring without deprecations.It's probably easiest for review to go through the commits one after the other. Each is a simple change, but they often touch the same code so that separate PRs would depend on each other.I've stripped this down for easier review. This is now two commits, which I suggest should be kept (i.e. please do not squash)
Substitutionand_ArtistPropertiesSubstitution independentThey do not have relevant functional overlap. Thus, it's simpler to keep them completely separated.
_ArtistPropertiesSubstitution.update()toregister()While it's internally a dict.update. The logical process is a registration to make the names publically available. Also,
remove the possibility to pass a dict. Passing kwargs is enough and we can simplify the API to only one type of usage.