Change default behaviour of setting logscale to 'mask'

dstansby · dstansby · commit dda42abd9633 · 2017-07-03T21:26:48.000+01:00
diff --git a/doc/api/api_changes/2017-07-03-DS-logscale_masked.rst b/doc/api/api_changes/2017-07-03-DS-logscale_masked.rst
@@ -0,0 +1,8 @@
+Default behavior of log scales changed to mask <= 0 values
+``````````````````````````````````````````````````````````
+
+Calling `matplotlib.Axes.set_xscale` or `matplotlib.Axes.set_yscale` now uses
+'mask' as the default method to handle invalid values (as opposed to 'clip').
+This means that any values <= 0 on a log scale will not be shown.
+
+Previously they were clipped to a very small number and shown.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1578,7 +1578,6 @@ def semilogx(self, *args, **kwargs):
             self.cla()
         d = {'basex': kwargs.pop('basex', 10),
              'subsx': kwargs.pop('subsx', None),
-             'nonposx': kwargs.pop('nonposx', 'mask'),
              }
 
         self.set_xscale('log', **d)
@@ -1629,7 +1628,6 @@ def semilogy(self, *args, **kwargs):
             self.cla()
         d = {'basey': kwargs.pop('basey', 10),
              'subsy': kwargs.pop('subsy', None),
-             'nonposy': kwargs.pop('nonposy', 'mask'),
              }
         self.set_yscale('log', **d)
         b = self._hold
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -2961,10 +2961,10 @@ def set_xscale(self, value, **kwargs):
 
         matplotlib.scale.LogisticTransform : logit transform
         """
-        # If the scale is being set to log, clip nonposx to prevent headaches
+        # If the scale is being set to log, mask nonposx to prevent headaches
         # around zero
         if value.lower() == 'log' and 'nonposx' not in kwargs:
-            kwargs['nonposx'] = 'clip'
+            kwargs['nonposx'] = 'mask'
 
         g = self.get_shared_x_axes()
         for ax in g.get_siblings(self):
@@ -3255,10 +3255,10 @@ def set_yscale(self, value, **kwargs):
 
         matplotlib.scale.LogisticTransform : logit transform
         """
-        # If the scale is being set to log, clip nonposy to prevent headaches
+        # If the scale is being set to log, mask nonposy to prevent headaches
         # around zero
         if value.lower() == 'log' and 'nonposy' not in kwargs:
-            kwargs['nonposy'] = 'clip'
+            kwargs['nonposy'] = 'mask'
 
         g = self.get_shared_y_axes()
         for ax in g.get_siblings(self):

Original file line number	Diff line number	Diff line change
`@@ -1578,7 +1578,6 @@ def semilogx(self, args, *kwargs):`
`1578`	`1578`	`self.cla()`
`1579`	`1579`	`d = {'basex': kwargs.pop('basex', 10),`
`1580`	`1580`	`'subsx': kwargs.pop('subsx', None),`
`1581`		`- 'nonposx': kwargs.pop('nonposx', 'mask'),`
`1582`	`1581`	`}`
`1583`	`1582`
`1584`	`1583`	`self.set_xscale('log', **d)`
`@@ -1629,7 +1628,6 @@ def semilogy(self, args, *kwargs):`
`1629`	`1628`	`self.cla()`
`1630`	`1629`	`d = {'basey': kwargs.pop('basey', 10),`
`1631`	`1630`	`'subsy': kwargs.pop('subsy', None),`
`1632`		`- 'nonposy': kwargs.pop('nonposy', 'mask'),`
`1633`	`1631`	`}`
`1634`	`1632`	`self.set_yscale('log', **d)`
`1635`	`1633`	`b = self._hold`