Commitc38e0f7

authored

Merge pull request#29691 from meeseeksmachine/auto-backport-of-pr-29584-on-v3.10.x

Backport PR#29584 on branch v3.10.x (DOC: Recommend constrained_layout over tight_layout)

2 parents14d07d6 +50cad2a commitc38e0f7Copy full SHA for c38e0f7

File tree

+14

-7

lines changed

+14

-7

lines changed

Lines changed: 6 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,17 @@`
`9`	`9`
`10`	`10`	`How to use tight-layout to fit plots within your figure cleanly.`
`11`	`11`
	`12`	`+.. tip::`
	`13`	`+`
	`14`	`+ tight_layout was the first layout engine in Matplotlib. The more modern`
	`15`	+ and more capable :ref:`Constrained Layout <constrainedlayout_guide>` should
	`16`	`+ typically be used instead.`
	`17`	`+`
`12`	`18`	`tight_layout automatically adjusts subplot params so that the`
`13`	`19`	`subplot(s) fits in to the figure area. This is an experimental`
`14`	`20`	`feature and may not work for some cases. It only checks the extents`
`15`	`21`	`of ticklabels, axis labels, and titles.`
`16`	`22`
`17`		-An alternative to tight_layout is :ref:`constrained_layout
`18`		-<constrainedlayout_guide>`.
`19`		`-`
`20`		`-`
`21`	`23`	`Simple example`
`22`	`24`	`==============`
`23`	`25`

Lines changed: 8 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,14 @@`
`10`	`10`	`layout engine while the figure is being created. In particular, colorbars are`
`11`	`11`	`made differently with different layout engines (for historical reasons).`
`12`	`12`
`13`		-Matplotlib supplies two layout engines, `.TightLayoutEngine` and
`14`		-`.ConstrainedLayoutEngine`. Third parties can create their own layout engine
`15`		-by subclassing `.LayoutEngine`.
	`13`	`+Matplotlib has two built-in layout engines:`
	`14`	`+`
	`15`	+- `.TightLayoutEngine` was the first layout engine added to Matplotlib.
	`16`	+ See also :ref:`tight_layout_guide`.
	`17`	+- `.ConstrainedLayoutEngine` is more modern and generally gives better results.
	`18`	+ See also :ref:`constrainedlayout_guide`.
	`19`	`+`
	`20`	+Third parties can create their own layout engine by subclassing `.LayoutEngine`.
`16`	`21`	`"""`
`17`	`22`
`18`	`23`	`fromcontextlibimportnullcontext`

Comments

(0)