Release note, deprecation notices, doc changes

trananso · trananso · commit 97c7da7a4323 · 2024-04-21T18:28:14.000-04:00
diff --git a/doc/_static/transforms.png b/doc/_static/transforms.png
diff --git a/doc/api/next_api_changes/deprecations/28098-AT.rst b/doc/api/next_api_changes/deprecations/28098-AT.rst
@@ -0,0 +1,9 @@
+``Affine2DBase``, ``BlendedAffine2D`` and ``CompositeAffine2D``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to support 3-dimensional transforms, the following deprecations have been
+made. The deprecated classes can be directly replaced with the new alternatives
+
+- ``Affine2DBase`` has been replaced with ``AffineImmutable``
+- ``BlendedAffine2D`` has been replaced with ``BlendedAffine``
+- ``CompositeAffine2D`` has been replaced with ``CompositeAffine``.
diff --git a/doc/api/transformations.rst b/doc/api/transformations.rst
@@ -7,10 +7,10 @@
 
 .. automodule:: matplotlib.transforms
    :members: TransformNode, BboxBase, Bbox, TransformedBbox, Transform,
-       TransformWrapper, AffineBase, Affine2DBase, Affine2D, IdentityTransform,
-       BlendedGenericTransform, BlendedAffine2D, blended_transform_factory,
-       CompositeGenericTransform, CompositeAffine2D,
-       composite_transform_factory, BboxTransform, BboxTransformTo,
+       TransformWrapper, AffineBase, AffineImmutable, Affine2DBase, Affine2D,
+       IdentityTransform, BlendedGenericTransform, BlendedAffine, BlendedAffine2D,
+       blended_transform_factory, CompositeGenericTransform, CompositeAffine,
+       CompositeAffine2D, composite_transform_factory, BboxTransform, BboxTransformTo,
        BboxTransformFrom, ScaledTranslation, TransformedPath, nonsingular,
        interval_contains, interval_contains_open
    :show-inheritance:
diff --git a/doc/users/next_whats_new/non_2d_transforms.rst b/doc/users/next_whats_new/non_2d_transforms.rst
@@ -0,0 +1,16 @@
+Added support for Non 2-dimensional transforms
+----------------------------------------------
+
+Support has been added for transforms in matplotlib that aren't 2D.
+
+``AffineImmutable`` directly replaces ``Affine2DBase``, and introduces a ``dims``
+keyword that specifies the dimension of the transform, defaulting to 2.
+
+``BlendedAffine`` directly replaces ``BlendedAffine2D``, and can blend more than
+two transforms, with each transform handling a different axis.
+
+``CompositeAffine`` directly replaces ``CompositeAffine2D``, and composes two Affine
+transforms, as long as they have the same dimensions.
+
+``IdentityTransform`` can create identity matrices of any dimension, through the use of
+the ``dims`` keyword.
diff --git a/galleries/tutorials/artists.py b/galleries/tutorials/artists.py
@@ -463,15 +463,15 @@ class in the Matplotlib API, and the one you will be working with most
 #     In [268]: print(rect.get_data_transform())
 #     CompositeGenericTransform(
 #         TransformWrapper(
-#             BlendedAffine2D(
+#             BlendedAffine(
 #                 IdentityTransform(),
 #                 IdentityTransform())),
 #         CompositeGenericTransform(
 #             BboxTransformFrom(
 #                 TransformedBbox(
 #                     Bbox(x0=0.0, y0=0.0, x1=1.0, y1=1.0),
 #                     TransformWrapper(
-#                         BlendedAffine2D(
+#                         BlendedAffine(
 #                             IdentityTransform(),
 #                             IdentityTransform())))),
 #             BboxTransformTo(
@@ -489,15 +489,15 @@ class in the Matplotlib API, and the one you will be working with most
 #     In [269]: print(ax.transData)
 #     CompositeGenericTransform(
 #         TransformWrapper(
-#             BlendedAffine2D(
+#             BlendedAffine(
 #                 IdentityTransform(),
 #                 IdentityTransform())),
 #         CompositeGenericTransform(
 #             BboxTransformFrom(
 #                 TransformedBbox(
 #                     Bbox(x0=0.0, y0=0.0, x1=1.0, y1=1.0),
 #                     TransformWrapper(
-#                         BlendedAffine2D(
+#                         BlendedAffine(
 #                             IdentityTransform(),
 #                             IdentityTransform())))),
 #             BboxTransformTo(
