Commiteb0917b

authored

Merge pull request#17094 from jklymak/doc-drop-experimental-constrained

DOC: drop the experimental tag constrained_layout and tight_layout

2 parents2227aa3 +41abaa5 commiteb0917bCopy full SHA for eb0917b

File tree

+15

-9

lines changed

+15

-9

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff 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`.

Lines changed: 5 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -30,12 +30,11 @@`
`30`	`30`
`31`	`31`	`.. warning::`
`32`	`32`
`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``.
`39`	`38`
`40`	`39`	`Simple Example`
`41`	`40`	`==============`

Lines changed: 3 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,9 @@`
`6`	`6`	`How to use tight-layout to fit plots within your figure cleanly.`
`7`	`7`
`8`	`8`	`tight_layout automatically adjusts subplot params so that the`
`9`		`-subplot(s) fits in to the figure area. Thisis an experimental`
`10`		`-feature and may not workfor some cases. It only checks the extents`
`11`		`-of ticklabels, axis labels,and titles.`
	`9`	`+subplot(s) fits in to the figure area. Thisfeature may not work`
	`10`	`+for some cases. It only checks the extents of ticklabels, axis labels,`
	`11`	`+and titles.`
`12`	`12`
`13`	`13`	An alternative to tight_layout is :doc:`constrained_layout
`14`	`14`	</tutorials/intermediate/constrainedlayout_guide>`.

Comments

(0)