Rename AnnotatedYRangeSelection to AnnotatedYRange and update references

Author: PierreRaybaut

CHANGELOG.md

@@ -15,7 +15,7 @@
   * Added support for item title in parameters data set (`RangeShapeParam`)
   * This concerns the `XRangeSelection` and `YRangeSelection` items
 * New annotated X and Y range selection items:
-  * Added `AnnotatedXRange` and `AnnotatedYRangeSelection` items
+  * Added `AnnotatedXRange` and `AnnotatedYRange` items
   * These items provide X and Y range selection with an annotation label
   * They can be created using `make.annotated_xrange` and `make.annotated_yrange` functions
 

doc/features/items/overview.rst

@@ -73,7 +73,7 @@ The following annotation items are available:
 * :py:class:`.AnnotatedPoint`
 * :py:class:`.AnnotatedSegment`
 * :py:class:`.AnnotatedXRange`
-* :py:class:`.AnnotatedYRangeSelection`
+* :py:class:`.AnnotatedYRange`
 * :py:class:`.AnnotatedRectangle`
 * :py:class:`.AnnotatedObliqueRectangle`
 * :py:class:`.AnnotatedEllipse`

doc/features/items/reference.rst

@@ -120,7 +120,7 @@ Annotations
    :members:
 .. autoclass:: plotpy.items.AnnotatedXRange
    :members:
-.. autoclass:: plotpy.items.AnnotatedYRangeSelection
+.. autoclass:: plotpy.items.AnnotatedYRange
    :members:
 .. autoclass:: plotpy.items.AnnotatedRectangle
    :members:

plotpy/builder/annotation.py

@@ -31,7 +31,7 @@
     AnnotatedRectangle,
     AnnotatedSegment,
     AnnotatedXRange,
-    AnnotatedYRangeSelection,
+    AnnotatedYRange,
 )
 from plotpy.styles import AnnotationParam
 
@@ -454,7 +454,7 @@ def annotated_yrange(
         transform_matrix: np.ndarray | None = None,
         readonly: bool | None = None,
         private: bool | None = None,
-    ) -> AnnotatedYRangeSelection:
+    ) -> AnnotatedYRange:
         """Make an annotated y-range selection `plot item`
 
         Args:
@@ -472,10 +472,10 @@ def annotated_yrange(
             private: private. Default is None
 
         Returns:
-            :py:class:`.AnnotatedYRangeSelection` object
+            :py:class:`.AnnotatedYRange` object
         """
         return self.__annotated_shape(
-            AnnotatedYRangeSelection,
+            AnnotatedYRange,
             (y0, y1),
             title,
             subtitle,

plotpy/io.py

@@ -617,7 +617,7 @@ def register_serializable_items(modname, classnames):
         "AnnotatedPoint",
         "AnnotatedSegment",
         "AnnotatedXRange",
-        "AnnotatedYRangeSelection",
+        "AnnotatedYRange",
         "AnnotatedRectangle",
         "AnnotatedObliqueRectangle",
         "AnnotatedEllipse",

plotpy/items/__init__.py

@@ -12,7 +12,7 @@
     AnnotatedPolygon,
     AnnotatedSegment,
     AnnotatedXRange,
-    AnnotatedYRangeSelection,
+    AnnotatedYRange,
     AnnotatedShape,
 )
 from .contour import ContourItem, create_contour_items

plotpy/items/annotation.py

@@ -786,7 +786,7 @@ def __init__(
         super().__init__(_min, _max, annotationparam, info_callback)
 
 
-class AnnotatedYRangeSelection(BaseAnnotatedRangeSelection):
+class AnnotatedYRange(BaseAnnotatedRangeSelection):
     """
     Construct an annotated Y range selection with properties set with
     *annotationparam* (see :py:class:`.styles.AnnotationParam`)

plotpy/tests/items/test_annotated_range.py

@@ -3,7 +3,7 @@
 # Licensed under the terms of the BSD 3-Clause
 # (see plotpy/LICENSE for details)
 
-"""Testing `AnnotatedXRange` and `AnnotatedYRangeSelection` items"""
+"""Testing `AnnotatedXRange` and `AnnotatedYRange` items"""
 
 # guitest: show
 
@@ -15,7 +15,7 @@
 
 
 def test_annotated_range_selection():
-    """Test AnnotatedXRange and AnnotatedYRangeSelection items"""
+    """Test AnnotatedXRange and AnnotatedYRange items"""
     x = np.linspace(-10, 10, 200)
     y = np.sin(np.sin(np.sin(x)))
     with qt_app_context(exec_loop=True):