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

Skip to content

Commit eb0917b

Browse files
authored
Merge pull request #17094 from jklymak/doc-drop-experimental-constrained
DOC: drop the experimental tag constrained_layout and tight_layout
2 parents 2227aa3 + 41abaa5 commit eb0917b

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Constrained layout is no longer marked as experimental
2+
------------------------------------------------------
3+
4+
The *constrained_layout* option for figures and gridspecs was introduced
5+
in Matplotlib 2.2, and is no longer considered experimental. For an
6+
overview of the feature, please see
7+
:doc:`/tutorials/intermediate/constrainedlayout_guide`.

tutorials/intermediate/constrainedlayout_guide.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@
3030
3131
.. warning::
3232
33-
Currently Constrained Layout is **experimental**. The
34-
behaviour and API are subject to change, or the whole functionality
35-
may be removed without a deprecation period. If you *require* your
36-
plots to be absolutely reproducible, get the Axes positions after
37-
running Constrained Layout and use ``ax.set_position()`` in your code
38-
with ``constrained_layout=False``.
33+
Constrained layout can lead to irreproducible plots
34+
as the solver sometimes returns slightly different results.
35+
If you *require* your plots to be absolutely reproducible, get the
36+
Axes positions after running Constrained Layout and use
37+
``ax.set_position()`` in your code with ``constrained_layout=False``.
3938
4039
Simple Example
4140
==============

tutorials/intermediate/tight_layout_guide.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
How to use tight-layout to fit plots within your figure cleanly.
77
88
*tight_layout* automatically adjusts subplot params so that the
9-
subplot(s) fits in to the figure area. This is an experimental
10-
feature and may not work for some cases. It only checks the extents
11-
of ticklabels, axis labels, and titles.
9+
subplot(s) fits in to the figure area. This feature may not work
10+
for some cases. It only checks the extents of ticklabels, axis labels,
11+
and titles.
1212
1313
An alternative to *tight_layout* is :doc:`constrained_layout
1414
</tutorials/intermediate/constrainedlayout_guide>`.

0 commit comments

Comments
 (0)