Add note on interaction between text wrapping and bbox_inches='tight'

timhoffm · timhoffm · commit 31d1d8925c0d · 2021-02-17T22:06:30.000+01:00
diff --git a/examples/text_labels_and_annotations/autowrap.py b/examples/text_labels_and_annotations/autowrap.py
@@ -5,6 +5,12 @@
 
 Matplotlib can wrap text automatically, but if it's too long, the text will be
 displayed slightly outside of the boundaries of the axis anyways.
+
+Note: Auto-wrapping does not work together with
+``savefig(..., bbox_inches='tight')``. The 'tight' setting rescales the canvas
+to accommodate all content and happens before wrapping. This affects
+jupyter notebook users because ``bbox_inches='tight'`` is the default setting
+for the ``%matplotlib inline`` backend.
 """
 
 import matplotlib.pyplot as plt
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -544,6 +544,14 @@ def set_wrap(self, wrap):
         Parameters
         ----------
         wrap : bool
+
+        Notes
+        -----
+        Wrapping does not work together with
+        ``savefig(..., bbox_inches='tight')`` (which is also internally used
+        by the ``%matplotlib inline`` in jupyter). The 'tight' setting
+        rescales the canvas to accommodate all content and happens before
+        wrapping.
         """
         self._wrap = wrap
 
