Skip to content

[Doc]: Reduce references to set_tight_layout #26637

Closed

Description

@oscargus

Documentation Link

https://matplotlib.org/stable/api/figure_api.html#matplotlib.figure.Figure.set_tight_layout

Problem

set_tight_layout is deprecated.

galleries/users_explain/axes/tight_layout_guide.py:# time the figure is redrawn, you can call ``fig.set_tight_layout(True)``, or,
lib/matplotlib/figure.py:            Whether to use the tight layout mechanism. See `.set_tight_layout`.
lib/matplotlib/figure.py:                ``tight_layout=True`` and use `.set_tight_layout` otherwise.
lib/matplotlib/figure.py:              decorations do not overlap. See `.set_tight_layout` for

Suggested improvement

Better to point to something else. Not sure if that should be TightLayoutEngine or the tight layout guide or what.

Activity

  1. QuLogic commented on Aug 31, 2023

    @QuLogic
    Member

    galleries/users_explain/axes/tight_layout_guide.py:# time the figure is redrawn, you can callfig.set_tight_layout(True), or,

    This one is gone already.

    lib/matplotlib/figure.py: Whether to use the tight layout mechanism. See .set_tight_layout.
    lib/matplotlib/figure.py: tight_layout=True and use .set_tight_layout otherwise.

    These are cross references for the tight_layout parameter, which is also discouraged, so I don't know that they need to be removed.

    lib/matplotlib/figure.py: decorations do not overlap. See .set_tight_layout for

    This one is the layout parameter, and maybe should point to TightLayoutEngine as well.

  2. added this to the v3.8.0 milestone on Aug 31, 2023
  3. added 2 commits that reference this issue on Aug 31, 2023
    0fef3d0
    f403f2e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions