Rename AnnotatedXRangeSelection to AnnotatedXRange and update references accordingly

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 `AnnotatedXRangeSelection` and `AnnotatedYRangeSelection` items
+  * Added `AnnotatedXRange` and `AnnotatedYRangeSelection` 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

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

doc/features/items/reference.rst

@@ -118,7 +118,7 @@ Annotations
    :members:
 .. autoclass:: plotpy.items.AnnotatedSegment
    :members:
-.. autoclass:: plotpy.items.AnnotatedXRangeSelection
+.. autoclass:: plotpy.items.AnnotatedXRange
    :members:
 .. autoclass:: plotpy.items.AnnotatedYRangeSelection
    :members:

plotpy/builder/annotation.py

@@ -30,7 +30,7 @@
     AnnotatedPolygon,
     AnnotatedRectangle,
     AnnotatedSegment,
-    AnnotatedXRangeSelection,
+    AnnotatedXRange,
     AnnotatedYRangeSelection,
 )
 from plotpy.styles import AnnotationParam
@@ -403,7 +403,7 @@ def annotated_xrange(
         transform_matrix: np.ndarray | None = None,
         readonly: bool | None = None,
         private: bool | None = None,
-    ) -> AnnotatedXRangeSelection:
+    ) -> AnnotatedXRange:
         """Make an annotated x-range selection `plot item`
 
         Args:
@@ -421,10 +421,10 @@ def annotated_xrange(
             private: private. Default is None
 
         Returns:
-            :py:class:`.AnnotatedXRangeSelection` object
+            :py:class:`.AnnotatedXRange` object
         """
         return self.__annotated_shape(
-            AnnotatedXRangeSelection,
+            AnnotatedXRange,
             (x0, x1),
             title,
             subtitle,

plotpy/io.py

@@ -616,7 +616,7 @@ def register_serializable_items(modname, classnames):
         "Axes",
         "AnnotatedPoint",
         "AnnotatedSegment",
-        "AnnotatedXRangeSelection",
+        "AnnotatedXRange",
         "AnnotatedYRangeSelection",
         "AnnotatedRectangle",
         "AnnotatedObliqueRectangle",

plotpy/items/__init__.py

@@ -11,7 +11,7 @@
     AnnotatedRectangle,
     AnnotatedPolygon,
     AnnotatedSegment,
-    AnnotatedXRangeSelection,
+    AnnotatedXRange,
     AnnotatedYRangeSelection,
     AnnotatedShape,
 )

plotpy/items/annotation.py

@@ -760,7 +760,7 @@ def attach(self, plot):
         self.shape.attach(plot)
 
 
-class AnnotatedXRangeSelection(BaseAnnotatedRangeSelection):
+class AnnotatedXRange(BaseAnnotatedRangeSelection):
     """
     Construct an annotated X 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 `AnnotatedXRangeSelection` and `AnnotatedYRangeSelection` items"""
+"""Testing `AnnotatedXRange` and `AnnotatedYRangeSelection` items"""
 
 # guitest: show
 
@@ -15,7 +15,7 @@
 
 
 def test_annotated_range_selection():
-    """Test AnnotatedXRangeSelection and AnnotatedYRangeSelection items"""
+    """Test AnnotatedXRange and AnnotatedYRangeSelection items"""
     x = np.linspace(-10, 10, 200)
     y = np.sin(np.sin(np.sin(x)))
     with qt_app_context(exec_loop=True):