Make most params to figure()/Figure() kwonly. #22421
Merged
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
This will allow tweaking the displayed signature of figure(), e.g. hiding `facecolor` and `edgecolor` (likely rarely used) into `kwargs` while making e.g. `layout` more prominent.
timhoffm
approved these changes
Feb 8, 2022
There was a problem hiding this comment.
At the risk of annoying some users. But
- hopefully not many people are affected.
- in their own interest, they should not pass these parameters positionally.
- it serves a concrete purpose within matplotlib (to improve the signature).
- it's a regular depreaction, so those who are affected have time to transition.
If this was new API, dpi would be kw-only, but I agree that we should be defensive to not affect more people than necessary.
QuLogic
approved these changes
Feb 11, 2022
Sign up for free
to 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.
This will allow tweaking the displayed signature of figure(), e.g.
hiding
facecolorandedgecolor(likely rarely used) intokwargswhile making e.g.
layoutmore prominent.(I deemed that passing figsize or dpi positionally, although probably not a good idea, could possibly make sense, but that's almost certainly not the case for facecolor and edgecolor...)
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).