:s/plotinvalid/plotnonfinite.

anntzer · anntzer · commit d3ebdd694458 · 2018-11-14T03:16:26.000+01:00
The name is a reference to the standard isfinite() function.
diff --git a/doc/api/next_api_changes/2018-11-14-AL-scatter.rst b/doc/api/next_api_changes/2018-11-14-AL-scatter.rst
@@ -9,6 +9,6 @@ by `PathCollection.get_array`)
 
 Such points are now included, but masked out by returning a masked array.
 
-If the *plotinvalid* kwarg to `~.Axes.scatter` is set, then points with
+If the *plotnonfinite* kwarg to `~.Axes.scatter` is set, then points with
 nonfinite values are plotted using the bad color of the `PathCollection`\ 's
 colormap (as set by `Colormap.set_bad`).
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4169,7 +4169,7 @@ def _parse_scatter_color_args(self, c, edgecolors, kwargs, xshape, yshape):
                       label_namer="y")
     def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
                 vmin=None, vmax=None, alpha=None, linewidths=None,
-                verts=None, edgecolors=None, *, plotinvalid=False,
+                verts=None, edgecolors=None, *, plotnonfinite=False,
                 **kwargs):
         """
         A scatter plot of *y* vs *x* with varying marker size and/or color.
@@ -4246,8 +4246,8 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             For non-filled markers, the *edgecolors* kwarg is ignored and
             forced to 'face' internally.
 
-        plotinvalid : boolean, optional, default: False
-            Set to plot valid points with invalid color, in conjunction with
+        plotnonfinite : boolean, optional, default: False
+            Set to plot points with nonfinite *c*, in conjunction with
             `~matplotlib.colors.Colormap.set_bad`.
 
         Returns
@@ -4302,7 +4302,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             self._parse_scatter_color_args(c, edgecolors, kwargs,
                                            xshape, yshape)
 
-        if plotinvalid and colors is None:
+        if plotnonfinite and colors is None:
             c = np.ma.masked_invalid(c)
             x, y, s, colors, edgecolors, linewidths = \
                 cbook._combine_masks(x, y, s, colors, edgecolors, linewidths)
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2835,12 +2835,13 @@ def quiverkey(Q, X, Y, U, label, **kw):
 def scatter(
         x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         vmin=None, vmax=None, alpha=None, linewidths=None, verts=None,
-        edgecolors=None, *, plotinvalid=False, data=None, **kwargs):
+        edgecolors=None, *, plotnonfinite=False, data=None, **kwargs):
     __ret = gca().scatter(
         x, y, s=s, c=c, marker=marker, cmap=cmap, norm=norm,
         vmin=vmin, vmax=vmax, alpha=alpha, linewidths=linewidths,
-        verts=verts, edgecolors=edgecolors, plotinvalid=plotinvalid,
-        **({"data": data} if data is not None else {}), **kwargs)
+        verts=verts, edgecolors=edgecolors,
+        plotnonfinite=plotnonfinite, **({"data": data} if data is not
+        None else {}), **kwargs)
     sci(__ret)
     return __ret
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -1753,7 +1753,7 @@ def test_scatter_invalid_color(self, fig_test, fig_ref):
         # stamping fast path, which would result in slightly offset markers.
         ax.scatter(range(4), range(4),
                    c=[1, np.nan, 2, np.nan], s=[1, 2, 3, 4],
-                   cmap=cmap, plotinvalid=True)
+                   cmap=cmap, plotnonfinite=True)
         ax = fig_ref.subplots()
         cmap = plt.get_cmap("viridis", 16)
         ax.scatter([0, 2], [0, 2], c=[1, 2], s=[1, 3], cmap=cmap)
