Skip to content

DOC: remove experimental tag from CL #21975

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
merged 1 commit into from
Dec 17, 2021
Merged

DOC: remove experimental tag from CL #21975

Show file tree
Hide file tree
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
20 changes: 10 additions & 10 deletions lib/matplotlib/figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2212,22 +2212,22 @@ def __init__(self,
The use of this parameter is discouraged. Please use
``layout='constrained'`` instead.

layout : {'constrained', 'tight'}, optional
The layout mechanism for positioning of plot elements.
Supported values:
layout : {'constrained', 'tight'}, optional, default: None
The layout mechanism for positioning of plot elements to avoid
overlapping Axes decorations (labels, ticks, etc). Note that
layout managers can have significant performance penalties.

- 'constrained': The constrained layout solver usually gives the
best layout results and is thus recommended. However, it is
computationally expensive and can be slow for complex figures
with many elements.
- 'constrained': The constrained layout solver adjusts axes sizes
to avoid overlapping axes decorations. Can handle complex plot
layouts and colorbars, and is thus recommended.

See :doc:`/tutorials/intermediate/constrainedlayout_guide`
for examples.

- 'tight': Use the tight layout mechanism. This is a relatively
simple algorithm, that adjusts the subplot parameters so that
decorations like tick labels, axis labels and titles have enough
space. See `.Figure.set_tight_layout` for further details.
simple algorithm that adjusts the subplot parameters so that
decorations do not overlap. See `.Figure.set_tight_layout` for
further details.

If not given, fall back to using the parameters *tight_layout* and
*constrained_layout*, including their config defaults
Expand Down
9 changes: 0 additions & 9 deletions tutorials/intermediate/constrainedlayout_guide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,6 @@

Those are described in detail throughout the following sections.

.. warning::

Currently Constrained Layout is **experimental**. The
behaviour and API are subject to change, or the whole functionality
may be removed without a deprecation period. If you *require* your
plots to be absolutely reproducible, get the Axes positions after
running Constrained Layout and use ``ax.set_position()`` in your code
with ``constrained_layout=False``.

Simple Example
==============

Expand Down