Merge pull request #16096 from timhoffm/depecate-unused

jklymak · web-flow · commit 45cfd873fd37 · 2020-01-06T08:46:37.000-08:00
Deprecate unused parameters
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -110,3 +110,12 @@ them.
 ``args_key`` and ``exec_key`` attributes of builtin `.MovieWriter`\s
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 These attributes are deprecated.
+
+Unused parameters
+~~~~~~~~~~~~~~~~~
+The following parameters do not have any effect and are deprecated:
+
+- arbitrary keyword arguments to ``StreamplotSet``
+- parameter *quantize* of `.Path.cleaned()`
+- parameter *s* of `.AnnotationBbox.get_fontsize()`
+- parameter *label* of `.Tick`
diff --git a/examples/specialty_plots/skewt.py b/examples/specialty_plots/skewt.py
@@ -56,7 +56,7 @@ def get_view_interval(self):
 # as well as create instances of the custom tick
 class SkewXAxis(maxis.XAxis):
     def _get_tick(self, major):
-        return SkewXTick(self.axes, None, '', major=major)
+        return SkewXTick(self.axes, None, major=major)
 
     def get_view_interval(self):
         return self.axes.upper_xlim[0], self.axes.lower_xlim[1]
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -53,7 +53,8 @@ class Tick(martist.Artist):
         The right/top tick label.
 
     """
-    def __init__(self, axes, loc, label,
+    @cbook._delete_parameter("3.3", "label")
+    def __init__(self, axes, loc, label=None,
                  size=None,  # points
                  width=None,
                  color=None,
@@ -1877,7 +1878,7 @@ def _get_tick(self, major):
             tick_kw = self._major_tick_kw
         else:
             tick_kw = self._minor_tick_kw
-        return XTick(self.axes, 0, '', major=major, **tick_kw)
+        return XTick(self.axes, 0, major=major, **tick_kw)
 
     def set_label_position(self, position):
         """
@@ -2173,7 +2174,7 @@ def _get_tick(self, major):
             tick_kw = self._major_tick_kw
         else:
             tick_kw = self._minor_tick_kw
-        return YTick(self.axes, 0, '', major=major, **tick_kw)
+        return YTick(self.axes, 0, major=major, **tick_kw)
 
     def set_label_position(self, position):
         """
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2692,7 +2692,13 @@ def set_message(self, s):
         """Display a message on toolbar or in status bar."""
 
     def back(self, *args):
-        """Move back up the view lim stack."""
+        """
+        Move back up the view lim stack.
+
+        For convenience of being directly connected as a GUI callback, which
+        often get passed additional parameters, this method accepts arbitrary
+        parameters, but does not use them.
+        """
         self._nav_stack.back()
         self.set_history_buttons()
         self._update_view()
@@ -2708,13 +2714,25 @@ def remove_rubberband(self):
         """Remove the rubberband."""
 
     def forward(self, *args):
-        """Move forward in the view lim stack."""
+        """
+        Move forward in the view lim stack.
+
+        For convenience of being directly connected as a GUI callback, which
+        often get passed additional parameters, this method accepts arbitrary
+        parameters, but does not use them.
+        """
         self._nav_stack.forward()
         self.set_history_buttons()
         self._update_view()
 
     def home(self, *args):
-        """Restore the original view."""
+        """
+        Restore the original view.
+
+        For convenience of being directly connected as a GUI callback, which
+        often get passed additional parameters, this method accepts arbitrary
+        parameters, but does not use them.
+        """
         self._nav_stack.home()
         self.set_history_buttons()
         self._update_view()
diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -1577,6 +1577,7 @@ def set_fontsize(self, s=None):
         self.prop = FontProperties(size=s)
         self.stale = True
 
+    @cbook._delete_parameter("3.3", "s")
     def get_fontsize(self, s=None):
         """Return the fontsize in points."""
         return self.prop.get_size_in_points()
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -416,6 +416,7 @@ def iter_segments(self, transform=None, remove_nans=True, clip=None,
                     curr_vertices = np.append(curr_vertices, next(vertices))
             yield curr_vertices, code
 
+    @cbook._delete_parameter("3.3", "quantize")
     def cleaned(self, transform=None, remove_nans=False, clip=None,
                 quantize=False, simplify=False, curves=False,
                 stroke_width=1.0, snap=False, sketch=None):
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -352,7 +352,7 @@ def _get_tick(self, major):
             tick_kw = self._major_tick_kw
         else:
             tick_kw = self._minor_tick_kw
-        return ThetaTick(self.axes, 0, '', major=major, **tick_kw)
+        return ThetaTick(self.axes, 0, major=major, **tick_kw)
 
     def _wrap_locator_formatter(self):
         self.set_major_locator(ThetaLocator(self.get_major_locator()))
@@ -659,7 +659,7 @@ def _get_tick(self, major):
             tick_kw = self._major_tick_kw
         else:
             tick_kw = self._minor_tick_kw
-        return RadialTick(self.axes, 0, '', major=major, **tick_kw)
+        return RadialTick(self.axes, 0, major=major, **tick_kw)
 
     def _wrap_locator_formatter(self):
         self.set_major_locator(RadialLocator(self.get_major_locator(),
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -233,6 +233,10 @@ def streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None,
 class StreamplotSet:
 
     def __init__(self, lines, arrows, **kwargs):
+        if kwargs:
+            cbook.warn_deprecated(
+                "3.3", "Passing arbitrary keyword arguments to StreamplotSet "
+                       "is deprecated.")
         self.lines = lines
         self.arrows = arrows
 
diff --git a/lib/matplotlib/tests/test_skew.py b/lib/matplotlib/tests/test_skew.py
@@ -46,7 +46,7 @@ def get_view_interval(self):
 # as well as create instances of the custom tick
 class SkewXAxis(maxis.XAxis):
     def _get_tick(self, major):
-        return SkewXTick(self.axes, None, '', major=major)
+        return SkewXTick(self.axes, None, major=major)
 
     def get_view_interval(self):
         return self.axes.upper_xlim[0], self.axes.lower_xlim[1]
