From 3807a329bee8fb0ec311fb97e9e354883defc097 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Thu, 6 Feb 2025 14:45:36 +0100 Subject: [PATCH] DOC: Document that tight_layout may not converge Closes #21742. --- galleries/users_explain/axes/tight_layout_guide.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/galleries/users_explain/axes/tight_layout_guide.py b/galleries/users_explain/axes/tight_layout_guide.py index dcffa7437b94..455bb57de126 100644 --- 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 # ================= #