Update plt.figure() docstring. #22420
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
6 tasks
timhoffm
reviewed
Feb 7, 2022
timhoffm
reviewed
Feb 7, 2022
timhoffm
reviewed
Feb 7, 2022
timhoffm
approved these changes
Feb 7, 2022
QuLogic
reviewed
Feb 8, 2022
lib/matplotlib/pyplot.py
Outdated
|
|
||
| **kwargs : optional | ||
| See `~.matplotlib.figure.Figure` for other possible arguments. | ||
| Additional kwargs will be passed to the `.Figure` constructor. |
There was a problem hiding this comment.
Suggested change
| Additional kwargs will be passed to the `.Figure` constructor. | |
| Additional keyword arguments will be passed to the `.Figure` constructor. |
jklymak
reviewed
Feb 8, 2022
lib/matplotlib/pyplot.py
Outdated
|
|
||
| Notes | ||
| ----- | ||
| Newly created figures will be passed to the ``new_figure_manager`` function | ||
| provided by the current backend, which will install a canvas and a manager |
There was a problem hiding this comment.
Is it possible to link out to something here? Otherwise these terms aren't very meaningful to most people.
There was a problem hiding this comment.
Sure, linked https://matplotlib.org/stable/api/backend_template_api.html#matplotlib.backends.backend_template.new_figure_manager which I think is the best for now.
- Don't suggest using backends for customization (it's quite heavy handed anyways, and we may soon have figure hooks to simplify that). - Replace tight_layout/constrained_layout by layout engines (none of the kwargs appear explicitly in the signature, but because figure() is such a central entry point, it seems reasonable to be a bit more wordy in the descriptions).
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.
handed anyways, and we may soon have figure hooks to simplify that).
kwargs appear explicitly in the signature, but because figure() is
such a central entry point, it seems reasonable to be a bit more wordy
in the descriptions).
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).