Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8cbe67e

Browse files
committed
DOC: remove experimental tag from CL
1 parent 0fc7c4b commit 8cbe67e

File tree

2 files changed

+10
-19
lines changed

2 files changed

+10
-19
lines changed

lib/matplotlib/figure.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2212,22 +2212,22 @@ def __init__(self,
22122212
The use of this parameter is discouraged. Please use
22132213
``layout='constrained'`` instead.
22142214
2215-
layout : {'constrained', 'tight'}, optional
2216-
The layout mechanism for positioning of plot elements.
2217-
Supported values:
2215+
layout : {'constrained', 'tight'}, optional, default: None
2216+
The layout mechanism for positioning of plot elements to avoid
2217+
overlapping Axes decorations (labels, ticks, etc). Note that
2218+
layout managers can have significant performance penalties.
22182219
2219-
- 'constrained': The constrained layout solver usually gives the
2220-
best layout results and is thus recommended. However, it is
2221-
computationally expensive and can be slow for complex figures
2222-
with many elements.
2220+
- 'constrained': The constrained layout solver adjusts axes sizes
2221+
to avoid overlapping axes decorations. Can handle complex plot
2222+
layouts and colorbars, and is thus recommended.
22232223
22242224
See :doc:`/tutorials/intermediate/constrainedlayout_guide`
22252225
for examples.
22262226
22272227
- 'tight': Use the tight layout mechanism. This is a relatively
2228-
simple algorithm, that adjusts the subplot parameters so that
2229-
decorations like tick labels, axis labels and titles have enough
2230-
space. See `.Figure.set_tight_layout` for further details.
2228+
simple algorithm that adjusts the subplot parameters so that
2229+
decorations do not overlap. See `.Figure.set_tight_layout` for
2230+
further details.
22312231
22322232
If not given, fall back to using the parameters *tight_layout* and
22332233
*constrained_layout*, including their config defaults

tutorials/intermediate/constrainedlayout_guide.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,6 @@
2929
3030
Those are described in detail throughout the following sections.
3131
32-
.. warning::
33-
34-
Currently Constrained Layout is **experimental**. The
35-
behaviour and API are subject to change, or the whole functionality
36-
may be removed without a deprecation period. If you *require* your
37-
plots to be absolutely reproducible, get the Axes positions after
38-
running Constrained Layout and use ``ax.set_position()`` in your code
39-
with ``constrained_layout=False``.
40-
4132
Simple Example
4233
==============
4334

0 commit comments

Comments
 (0)