Release note, deprecation notices, doc changes

matplotlib · Apr 21, 2024 · 983b318 · 983b318
1 parent 50d469d
commit 983b318
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
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/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.