MAINT renamed sublabel_filtering to label_pruning

NelleV · NelleV · commit 80dc75ac3818 · 2016-11-24T10:24:21.000-08:00
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
@@ -252,7 +252,7 @@ def set_default_locators_and_formatters(self, axis):
         axis.set_minor_formatter(
             LogFormatterSciNotation(self.base,
                                     labelOnlyBase=self.subs,
-                                    sublabel_filtering=True))
+                                    label_pruning=True))
 
     def get_transform(self):
         """
diff --git a/lib/matplotlib/tests/test_ticker.py b/lib/matplotlib/tests/test_ticker.py
@@ -243,7 +243,7 @@ def test_LogFormatter_sublabel():
     ax.xaxis.set_major_formatter(mticker.LogFormatter(labelOnlyBase=True))
     ax.xaxis.set_minor_formatter(mticker.LogFormatter(
         labelOnlyBase=False,
-        sublabel_filtering=True))
+        label_pruning=True))
     # axis range above 3 decades, only bases are labeled
     ax.set_xlim(1, 1e4)
     fmt = ax.xaxis.get_major_formatter()
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -801,25 +801,25 @@ class LogFormatter(Formatter):
     Format values for log axis.
     """
     def __init__(self, base=10.0, labelOnlyBase=False,
-                 sublabel_filtering=False):
+                 label_pruning=False):
         """
         `base` is used to locate the decade tick, which will be the only
         one to be labeled if `labelOnlyBase` is ``True``.
 
-        Parameter
-        ---------
+        Parameters
+        ----------
         base : float, optional, default: 10.
             base of the logarithm.
 
         labelOnlyBase : bool, optional, default: False
-             whether to only label decades ticks.
+            whether to only label decades ticks.
 
-        sublabel_filtering : bool, optional, default: False
-            When set to True, label on a subset of ticks.
+        label_pruning : bool, optional, default: False
+            when set to True, label on a subset of ticks.
         """
         self._base = base + 0.0
         self.labelOnlyBase = labelOnlyBase
-        self.sublabel_filtering = sublabel_filtering
+        self.label_pruning = label_pruning
         self._sublabels = [1, ]
 
     def base(self, base):
@@ -895,7 +895,7 @@ def __call__(self, x, pos=None):
         exponent = np.round(fx) if isDecade else np.floor(fx)
         coeff = np.round(x / b ** exponent)
 
-        if self.sublabel_filtering and coeff not in self._sublabels:
+        if self.label_pruning and coeff not in self._sublabels:
             return ''
         if not isDecade and self.labelOnlyBase:
             return ''
@@ -976,10 +976,10 @@ def __call__(self, x, pos=None):
         fx = math.log(abs(x)) / math.log(b)
 
         isDecade = is_close_to_int(fx)
-        exponent = np.round(fx) if is_decade else np.floor(fx)
+        exponent = np.round(fx) if isDecade else np.floor(fx)
         coeff = np.round(abs(x) / b ** exponent)
 
-        if self.sublabel_filtering and coeff not in self._sublabels:
+        if self.label_pruning and coeff not in self._sublabels:
             return ''
         if not isDecade and self.labelOnlyBase:
             return ''
@@ -1039,7 +1039,7 @@ def __call__(self, x, pos=None):
         else:
             base = '%s' % b
 
-        if self.sublabel_filtering and coeff not in self._sublabels:
+        if self.label_pruning and coeff not in self._sublabels:
             return ''
         if not is_decade and self.labelOnlyBase:
             return ''
