Merge pull request #27513 from oscargus/transformtestdoc

QuLogic · web-flow · commit 5f52428125c7 · 2023-12-14T16:55:39.000-05:00
Fix docs and add tests for transform and deprecate `BboxTransformToMaxOnly`
diff --git a/doc/api/next_api_changes/deprecations/27513-OG.rst b/doc/api/next_api_changes/deprecations/27513-OG.rst
@@ -0,0 +1,5 @@
+``BboxTransformToMaxOnly``
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+... is deprecated without replacement. If you rely on this, please make a copy of the
+code.
diff --git a/lib/matplotlib/tests/test_transforms.py b/lib/matplotlib/tests/test_transforms.py
@@ -1054,3 +1054,21 @@ def test_transformedbbox_contains():
     assert bb.contains(1.25, 1.5)
     assert not bb.fully_contains(1.25, 1.5)
     assert not bb.fully_contains(.1, .1)
+
+
+def test_interval_contains():
+    assert mtransforms.interval_contains((0, 1), 0.5)
+    assert mtransforms.interval_contains((0, 1), 0)
+    assert mtransforms.interval_contains((0, 1), 1)
+    assert not mtransforms.interval_contains((0, 1), -1)
+    assert not mtransforms.interval_contains((0, 1), 2)
+    assert mtransforms.interval_contains((1, 0), 0.5)
+
+
+def test_interval_contains_open():
+    assert mtransforms.interval_contains_open((0, 1), 0.5)
+    assert not mtransforms.interval_contains_open((0, 1), 0)
+    assert not mtransforms.interval_contains_open((0, 1), 1)
+    assert not mtransforms.interval_contains_open((0, 1), -1)
+    assert not mtransforms.interval_contains_open((0, 1), 2)
+    assert mtransforms.interval_contains_open((1, 0), 0.5)
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -2617,9 +2617,10 @@ def get_matrix(self):
         return self._mtx
 
 
+@_api.deprecated("3.9")
 class BboxTransformToMaxOnly(BboxTransformTo):
     """
-    `BboxTransformTo` is a transformation that linearly transforms points from
+    `BboxTransformToMaxOnly` is a transformation that linearly transforms points from
     the unit bounding box to a given `Bbox` with a fixed upper left of (0, 0).
     """
     def get_matrix(self):
