Merge pull request #11631 from jklymak/doc-better-tl-error

NelleV · web-flow · commit a60c37c65013 · 2018-07-13T09:36:24.000-07:00
DOC: better tight_layout error handling
diff --git a/lib/matplotlib/tests/test_tightlayout.py b/lib/matplotlib/tests/test_tightlayout.py
@@ -305,3 +305,14 @@ def test_big_decorators_vertical():
     with warnings.catch_warnings(record=True) as w:
         fig.tight_layout()
         assert len(w) == 1
+
+
+def test_badsubplotgrid():
+    # test that we get warning for mismatched subplot grids rather
+    # than an error
+    ax1 = plt.subplot2grid((4, 5), (0, 0))
+    # this is the bad entry:
+    ax5 = plt.subplot2grid((5, 5), (0, 3), colspan=3, rowspan=5)
+    with warnings.catch_warnings(record=True) as w:
+        plt.tight_layout()
+        assert len(w) == 1
diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py
@@ -326,8 +326,16 @@ def get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer,
         rows, cols, num1, num2 = subplotspec.get_geometry()
         div_row, mod_row = divmod(max_nrows, rows)
         div_col, mod_col = divmod(max_ncols, cols)
-        if (mod_row != 0) or (mod_col != 0):
-            raise RuntimeError("")
+        if mod_row != 0:
+            warnings.warn('tight_layout not applied: '
+                          'number of rows in subplot specifications must'
+                          'be multiples of one another.')
+            return {}
+        if mod_col != 0:
+            warnings.warn('tight_layout not applied: '
+                          'number of columns in subplot specifications must'
+                          'be multiples of one another.')
+            return {}
 
         rowNum1, colNum1 = divmod(num1, cols)
         if num2 is None:
