Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Update plt.figure() docstring.#22420

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
timhoffm merged 1 commit intomatplotlib:mainfromanntzer:figdoc
Feb 8, 2022
Merged

Conversation

anntzer
Copy link
Contributor

  • 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).

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).


**kwargs : optional
See `~.matplotlib.figure.Figure`for other possible arguments.
Additional kwargs will be passed to the `.Figure`constructor.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
Additionalkwargswillbepassedtothe`.Figure`constructor.
Additionalkeywordargumentswillbepassedtothe`.Figure`constructor.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

yes


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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Is it possible to link out to something here? Otherwise these terms aren't very meaningful to most people.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

- 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).
@timhoffmtimhoffm merged commitc0c3627 intomatplotlib:mainFeb 8, 2022
@anntzeranntzer deleted the figdoc branchFebruary 8, 2022 16:57
@QuLogicQuLogic added this to thev3.6.0 milestoneFeb 8, 2022
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic left review comments

@jklymakjklymakjklymak left review comments

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.

4 participants
@anntzer@QuLogic@jklymak@timhoffm
[8]ページ先頭
©2009-2025 Movatter.jp