10000 Cleanup tight_layout. by anntzer · Pull Request #20091 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Cleanup tight_layout. #20091

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

Merged
merged 1 commit into from
Apr 27, 2021
Merged

Cleanup tight_layout. #20091

merged 1 commit into from
Apr 27, 2021

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Apr 27, 2021
  • In get_tight_layout_figure, num2 is never None (since 658bbd5). Also
    rename some variables for pep8.
  • auto_adjust_subplotpars could also be adjusted to remove the
    num2 is None case, but in theory one could directly pass a
    None-containing argument to it. On the other hand it seems unlikely
    that anyone is actually directly calling auto_adjust_subplotpars,
    given the complex list of arguments needed (IOW it is clearly just a
    helper for get_tight_layout_figure), so just deprecate the whole
    function as public API, leaving a thin compat wrapper that remove
    None-inputs as needed.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

- In get_tight_layout_figure, num2 is never None (since 658bbd5).  Also
  rename some variables for pep8.
- auto_adjust_subplotpars could also be adjusted to remove the
  `num2 is None` case, but in theory one could directly pass a
  None-containing argument to it.  On the other hand it seems unlikely
  that anyone is actually directly calling auto_adjust_subplotpars,
  given the complex list of arguments needed (IOW it is clearly just a
  helper for get_tight_layout_figure), so just deprecate the whole
  function as public API, leaving a thin compat wrapper that remove
  None-inputs as needed.
@anntzer anntzer added topic: geometry manager LayoutEngine, Constrained layout, Tight layout Maintenance labels Apr 27, 2021
@anntzer anntzer added this to the v3.5.0 milestone Apr 27, 2021
@timhoffm timhoffm merged commit a94acb3 into matplotlib:master Apr 27, 2021
@anntzer anntzer deleted the tl branch April 27, 2021 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance topic: geometry manager LayoutEngine, Constrained layout, Tight layout
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0