From 0eef05f0b40bc746fe57a4b85beb67e6df205ef1 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Tue, 28 Jul 2020 13:09:07 -0700 Subject: [PATCH 1/2] DOC: update tight layout guide with set_in_layout --- tutorials/intermediate/tight_layout_guide.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tutorials/intermediate/tight_layout_guide.py b/tutorials/intermediate/tight_layout_guide.py index d186d0ed1a3e..a5eaef3cca54 100644 --- a/tutorials/intermediate/tight_layout_guide.py +++ b/tutorials/intermediate/tight_layout_guide.py @@ -152,13 +152,13 @@ def example_plot(ax, fontsize=12): # Caveats # ======= # -# * :func:`~matplotlib.pyplot.tight_layout` only considers ticklabels, axis -# labels, and titles. Thus, other artists may be clipped and also may -# overlap. +# * :func:`~matplotlib.pyplot.tight_layout` by default considers all artists +# on the axes. To remove an artist from the layout calculation you can call +# `~.Artist.set_in_layout`. # -# * It assumes that the extra space needed for ticklabels, axis labels, -# and titles is independent of original location of axes. This is -# often true, but there are rare cases where it is not. +# * It assumes that the extra space needed for artists is independent of +# original location of axes. This is often true, but there are rare cases +# where it is not. # # * pad=0 clips some of the texts by a few pixels. This may be a bug or # a limitation of the current algorithm and it is not clear why it From 192f329555fdce383cfe9e8e9890f934e17fb41b Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Tue, 28 Jul 2020 15:44:09 -0700 Subject: [PATCH 2/2] DOC: update tight layout guide with set_in_layout --- tutorials/intermediate/tight_layout_guide.py | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/tutorials/intermediate/tight_layout_guide.py b/tutorials/intermediate/tight_layout_guide.py index a5eaef3cca54..c8234fa881c7 100644 --- a/tutorials/intermediate/tight_layout_guide.py +++ b/tutorials/intermediate/tight_layout_guide.py @@ -152,18 +152,17 @@ def example_plot(ax, fontsize=12): # Caveats # ======= # -# * :func:`~matplotlib.pyplot.tight_layout` by default considers all artists -# on the axes. To remove an artist from the layout calculation you can call -# `~.Artist.set_in_layout`. +# * `~matplotlib.pyplot.tight_layout` considers all artists on the axes by +# default. To remove an artist from the layout calculation you can call +# `.Artist.set_in_layout`. # -# * It assumes that the extra space needed for artists is independent of -# original location of axes. This is often true, but there are rare cases -# where it is not. +# * ``tight_layout`` assumes that the extra space needed for artists is +# independent of the original location of axes. This is often true, but there +# are rare cases where it is not. # -# * pad=0 clips some of the texts by a few pixels. This may be a bug or -# a limitation of the current algorithm and it is not clear why it -# happens. Meanwhile, use of pad at least larger than 0.3 is -# recommended. +# * ``pad=0`` can clip some texts by a few pixels. This may be a bug or +# a limitation of the current algorithm and it is not clear why it +# happens. Meanwhile, use of pad larger than 0.3 is recommended. # # Use with GridSpec # =================