Merge pull request #14511 from timhoffm/deprecate-fill_between-where_scalar

tacaswell · web-flow · commit 965540c62f9b · 2019-08-07T21:44:27.000-04:00
API: Deprecate allowing scalars for fill_between where
diff --git a/doc/api/next_api_changes/2019-06-09-TH.rst b/doc/api/next_api_changes/2019-06-09-TH.rst
@@ -0,0 +1,8 @@
+Passing scalars to parameter where in ``fill_between()`` and ``fill_betweenx()``
+````````````````````````````````````````````````````````````````````````````````
+
+Passing scalars to parameter *where* in ``fill_between()`` and
+``fill_betweenx()`` is deprecated. While the documentation already states that
+*where* must be of the same size as *x* (or *y*), scalars were accepted and
+broadcasted to the size of *x*. Non-matching sizes will raise a ``ValueError``
+in the future.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -5169,6 +5169,14 @@ def fill_between(self, x, y1, y2=0, where=None, interpolate=False,
 
         if where is None:
             where = True
+        else:
+            where = np.asarray(where, dtype=bool)
+            if where.size != x.size:
+                cbook.warn_deprecated(
+                    "3.2",
+                    message="The parameter where must have the same size as x "
+                            "in fill_between(). This will become an error in "
+                            "future versions of Matplotlib.")
         where = where & ~functools.reduce(np.logical_or,
                                           map(np.ma.getmask, [x, y1, y2]))
 
@@ -5350,6 +5358,14 @@ def fill_betweenx(self, y, x1, x2=0, where=None,
 
         if where is None:
             where = True
+        else:
+            where = np.asarray(where, dtype=bool)
+            if where.size != y.size:
+                cbook.warn_deprecated(
+                    "3.2",
+                    message="The parameter where must have the same size as y "
+                            "in fill_between(). This will become an error in "
+                            "future versions of Matplotlib.")
         where = where & ~functools.reduce(np.logical_or,
                                           map(np.ma.getmask, [y, x1, x2]))
 
