Skip to content

TST: fix doc build #22383

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.

Sign up for GitHub

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
timhoffm merged 1 commit into from
Feb 3, 2022
Merged

TST: fix doc build #22383

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/api/next_api_changes/deprecations/22345-JK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Pending deprecation of layout methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The methods `~Figure.set_tight_layout`, `~Figure.set_constrained_layout`,
The methods `~.Figure.set_tight_layout`, `~.Figure.set_constrained_layout`,
are discouraged, and now emit a ``PendingDeprecationWarning`` in favor of
explicitly referencing the layout engine via
`figure.set_layout_engine('tight')` and
`figure.set_layout_engine('constrained')`. End users should not see the
``figure.set_layout_engine('tight')`` and
``figure.set_layout_engine('constrained')``. End users should not see the
warning, but library authors should adjust.

The methods `~Figure.set_constrained_layout_pads` and
`~Figure.get_constrained_layout_pads` are will be deprecated in favor of
The methods `~.Figure.set_constrained_layout_pads` and
`~.Figure.get_constrained_layout_pads` are will be deprecated in favor of
``figure.get_layout_engine().set()`` and
``figure.get_layout_engine().get()``, and currently emit a
``PendingDeprecationWarning``.