Merge pull request matplotlib#28183 from oscargus/axisandmore

Expire deprecations

Author: QuLogic

doc/api/axis_api.rst

@@ -217,6 +217,7 @@ Other
    Axis.axes
    Axis.limit_range_for_scale
    Axis.reset_ticks
+   Axis.set_clip_path
    Axis.set_default_intervals
 
 Discouraged
@@ -263,8 +264,7 @@ specify a matching series of labels.  Calling ``set_ticks`` makes a
    Tick.get_tick_padding
    Tick.get_tickdir
    Tick.get_view_interval
-   Tick.set_label1
-   Tick.set_label2
+   Tick.set_clip_path
    Tick.set_pad
    Tick.set_url
    Tick.update_position

doc/api/next_api_changes/removals/28183-OG.rst

@@ -0,0 +1,62 @@
+``Tick.set_label``, ``Tick.set_label1`` and ``Tick.set_label2``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... are removed.  Calling these methods from third-party code usually had no
+effect, as the labels are overwritten at draw time by the tick formatter.
+
+
+Functions in ``mpl_toolkits.mplot3d.proj3d``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The function ``transform`` is just an alias for ``proj_transform``,
+use the latter instead.
+
+The following functions were either unused (so no longer required in Matplotlib)
+or considered private.
+
+* ``ortho_transformation``
+* ``persp_transformation``
+* ``proj_points``
+* ``proj_trans_points``
+* ``rot_x``
+* ``rotation_about_vector``
+* ``view_transformation``
+
+
+Arguments other than ``renderer`` to ``get_tightbbox``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... are keyword-only arguments. This is for consistency and that
+different classes have different additional arguments.
+
+
+Method parameters renamed to match base classes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The only parameter of ``transform_affine`` and ``transform_non_affine`` in ``Transform`` subclasses is renamed
+to *values*.
+
+The *points* parameter of ``transforms.IdentityTransform.transform`` is renamed to *values*.
+
+The *trans* parameter of ``table.Cell.set_transform`` is renamed to *t* consistently with
+`.Artist.set_transform`.
+
+The *clippath* parameters of ``axis.Axis.set_clip_path``  and ``axis.Tick.set_clip_path`` are
+renamed to *path* consistently with `.Artist.set_clip_path`.
+
+The *s* parameter of ``images.NonUniformImage.set_filternorm`` is renamed to *filternorm*
+consistently with ``_ImageBase.set_filternorm``.
+
+The *s* parameter of ``images.NonUniformImage.set_filterrad`` is renamed to *filterrad*
+consistently with ``_ImageBase.set_filterrad``.
+
+The only parameter of ``Annotation.contains`` and ``Legend.contains`` is renamed to *mouseevent*
+consistently with `.Artist.contains`.
+
+Method parameters renamed
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The *p* parameter of ``BboxBase.padded`` is renamed to *w_pad*, consistently with the other parameter, *h_pad*
+
+*numdecs* parameter and attribute of ``LogLocator``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... are removed without replacement, because they had no effect.

doc/api/prev_api_changes/api_changes_3.8.0/deprecations.rst

@@ -153,10 +153,10 @@ The *clippath* parameters of ``axis.Axis.set_clip_path``  and ``axis.Tick.set_cl
 renamed to *path* consistently with `.Artist.set_clip_path`.
 
 The *s* parameter of ``images.NonUniformImage.set_filternorm`` is renamed to *filternorm*
-consistently with ```_ImageBase.set_filternorm``.
+consistently with ``_ImageBase.set_filternorm``.
 
 The *s* parameter of ``images.NonUniformImage.set_filterrad`` is renamed to *filterrad*
-consistently with ```_ImageBase.set_filterrad``.
+consistently with ``_ImageBase.set_filterrad``.
 
 
 *numdecs* parameter and attribute of ``LogLocator``

doc/api/toolkits/mplot3d.rst

@@ -118,12 +118,6 @@ the toolbar pan and zoom buttons are not used.
    :template: autosummary.rst
 
    proj3d.inv_transform
-   proj3d.persp_transformation
-   proj3d.proj_points
-   proj3d.proj_trans_points
    proj3d.proj_transform
    proj3d.proj_transform_clip
-   proj3d.rot_x
-   proj3d.transform
-   proj3d.view_transformation
    proj3d.world_transformation

lib/matplotlib/axes/_base.py

@@ -4425,9 +4425,8 @@ def get_default_bbox_extra_artists(self):
         return [a for a in artists if a.get_visible() and a.get_in_layout()
                 and (isinstance(a, noclip) or not a._fully_clipped_to_axes())]
 
-    @_api.make_keyword_only("3.8", "call_axes_locator")
-    def get_tightbbox(self, renderer=None, call_axes_locator=True,
-                      bbox_extra_artists=None, *, for_layout_only=False):
+    def get_tightbbox(self, renderer=None, *, call_axes_locator=True,
+                      bbox_extra_artists=None, for_layout_only=False):
         """
         Return the tight bounding box of the Axes, including axis and their
         decorators (xlabel, title, etc).

lib/matplotlib/axis.py

@@ -231,7 +231,6 @@ def get_children(self):
                     self.gridline, self.label1, self.label2]
         return children
 
-    @_api.rename_parameter("3.8", "clippath", "path")
     def set_clip_path(self, path, transform=None):
         # docstring inherited
         super().set_clip_path(path, transform)
@@ -278,32 +277,6 @@ def draw(self, renderer):
         renderer.close_group(self.__name__)
         self.stale = False
 
-    @_api.deprecated("3.8")
-    def set_label1(self, s):
-        """
-        Set the label1 text.
-
-        Parameters
-        ----------
-        s : str
-        """
-        self.label1.set_text(s)
-        self.stale = True
-
-    set_label = set_label1
-
-    @_api.deprecated("3.8")
-    def set_label2(self, s):
-        """
-        Set the label2 text.
-
-        Parameters
-        ----------
-        s : str
-        """
-        self.label2.set_text(s)
-        self.stale = True
-
     def set_url(self, url):
         """
         Set the url of label1 and label2.
@@ -833,6 +806,10 @@ def _set_axes_scale(self, value, **kwargs):
                 **{f"scale{k}": k == name for k in self.axes._axis_names})
 
     def limit_range_for_scale(self, vmin, vmax):
+        """
+        Return the range *vmin*, *vmax*, restricted to the domain supported by the
+        current scale.
+        """
         return self._scale.limit_range_for_scale(vmin, vmax, self.get_minpos())
 
     def _get_autoscale_on(self):
@@ -841,8 +818,9 @@ def _get_autoscale_on(self):
 
     def _set_autoscale_on(self, b):
         """
-        Set whether this Axis is autoscaled when drawing or by
-        `.Axes.autoscale_view`. If b is None, then the value is not changed.
+        Set whether this Axis is autoscaled when drawing or by `.Axes.autoscale_view`.
+
+        If b is None, then the value is not changed.
 
         Parameters
         ----------
@@ -1131,7 +1109,6 @@ def _translate_tick_params(kw, reverse=False):
         kwtrans.update(kw_)
         return kwtrans
 
-    @_api.rename_parameter("3.8", "clippath", "path")
     def set_clip_path(self, path, transform=None):
         super().set_clip_path(path, transform)
         for child in self.majorTicks + self.minorTicks:

lib/matplotlib/axis.pyi

@@ -60,9 +60,6 @@ class Tick(martist.Artist):
     def set_pad(self, val: float) -> None: ...
     def get_pad(self) -> None: ...
     def get_loc(self) -> float: ...
-    def set_label1(self, s: object) -> None: ...
-    def set_label(self, s: object) -> None: ...
-    def set_label2(self, s: object) -> None: ...
     def set_url(self, url: str | None) -> None: ...
     def get_view_interval(self) -> ArrayLike: ...
     def update_position(self, loc: float) -> None: ...

lib/matplotlib/figure.py

@@ -1797,8 +1797,7 @@ def get_default_bbox_extra_artists(self):
                 bbox_artists.extend(ax.get_default_bbox_extra_artists())
         return bbox_artists
 
-    @_api.make_keyword_only("3.8", "bbox_extra_artists")
-    def get_tightbbox(self, renderer=None, bbox_extra_artists=None):
+    def get_tightbbox(self, renderer=None, *, bbox_extra_artists=None):
         """
         Return a (tight) bounding box of the figure *in inches*.
 

lib/matplotlib/image.py

@@ -1129,11 +1129,9 @@ def get_extent(self):
             raise RuntimeError('Must set data first')
         return self._Ax[0], self._Ax[-1], self._Ay[0], self._Ay[-1]
 
-    @_api.rename_parameter("3.8", "s", "filternorm")
     def set_filternorm(self, filternorm):
         pass
 
-    @_api.rename_parameter("3.8", "s", "filterrad")
     def set_filterrad(self, filterrad):
         pass
 

lib/matplotlib/legend.py

@@ -1196,7 +1196,6 @@ def _find_best_position(self, width, height, renderer):
 
         return l, b
 
-    @_api.rename_parameter("3.8", "event", "mouseevent")
     def contains(self, mouseevent):
         return self.legendPatch.contains(mouseevent)