Merge pull request #11588 from jklymak/doc-warn-if-CL-plus-TL

tacaswell · tacaswell · commit 648a04e87112 · 2018-08-04T19:47:26.000-04:00
DOC: warn if user is using constrained layout and uses subplots_adjust

Conflicts:
	lib/matplotlib/figure.py
           - signature on master has changed to explicit kwargs,
             conflict due to that change.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -2090,7 +2090,14 @@ def subplots_adjust(self, *args, **kwargs):
         *None*) and update the subplot locations.
 
         """
+        if self.get_constrained_layout():
+            self.set_constrained_layout(False)
+            warnings.warn("This figure was using constrained_layout==True, "
+                          "but that is incompatible with subplots_adjust and "
+                          "or tight_layout: setting "
+                          "constrained_layout==False. ")
         self.subplotpars.update(*args, **kwargs)
+
         for ax in self.axes:
             if not isinstance(ax, SubplotBase):
                 # Check if sharing a subplots axis
diff --git a/lib/matplotlib/tests/test_figure.py b/lib/matplotlib/tests/test_figure.py
@@ -376,6 +376,14 @@ def test_figure_repr():
     assert repr(fig) == "<Figure size 100x200 with 0 Axes>"
 
 
+def test_warn_cl_plus_tl():
+    fig, ax = plt.subplots(constrained_layout=True)
+    with pytest.warns(UserWarning):
+        # this should warn,
+        fig.subplots_adjust(top=0.8)
+    assert not(fig.get_constrained_layout())
+
+
 @pytest.mark.skipif(sys.version_info < (3, 6), reason="requires Python 3.6+")
 @pytest.mark.parametrize("fmt", ["png", "pdf", "ps", "eps", "svg"])
 def test_fspath(fmt, tmpdir):
