Merge pull request #29585 from timhoffm/doc-tight_layout_converge

rcomer · web-flow · commit 91f52bc8b8e8 · 2025-02-07T20:20:51.000Z
DOC: Document that tight_layout may not converge
diff --git a/galleries/users_explain/axes/tight_layout_guide.py b/galleries/users_explain/axes/tight_layout_guide.py
@@ -165,6 +165,10 @@ def example_plot(ax, fontsize=12):
 #   a limitation of the current algorithm, and it is not clear why it
 #   happens. Meanwhile, use of pad larger than 0.3 is recommended.
 #
+# * The algorithm of ``tight_layout`` does not necessarily converge,
+#   i.e. calling ``tight_layout`` multiple times can lead to slight
+#   variations in the layout between the calls.
+#
 # Use with GridSpec
 # =================
 #

Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,10 @@ def example_plot(ax, fontsize=12):`
`165`	`165`	`# a limitation of the current algorithm, and it is not clear why it`
`166`	`166`	`# happens. Meanwhile, use of pad larger than 0.3 is recommended.`
`167`	`167`	`#`
	`168`	+# * The algorithm of ``tight_layout`` does not necessarily converge,
	`169`	+# i.e. calling ``tight_layout`` multiple times can lead to slight
	`170`	`+# variations in the layout between the calls.`
	`171`	`+#`
`168`	`172`	`# Use with GridSpec`
`169`	`173`	`# =================`
`170`	`174`	`#`