Fix docstrings issues (Qt intersphinx + newlines w/o space)

Author: PierreRaybaut

plotpy/events.py

@@ -30,6 +30,8 @@
 from plotpy.items.shape.marker import Marker
 
 if TYPE_CHECKING:
+    from qtpy.QtCore import QPoint
+
     from plotpy.plot.base import BasePlot
 
 CursorShape = type(QC.Qt.CursorShape.ArrowCursor)
@@ -663,7 +665,7 @@ def __init__(
         self.marker: Marker | None = None
 
     def get_pan_param(
-        self, plot: BasePlot, pos: QC.QPoint
+        self, plot: BasePlot, pos: QPoint
     ) -> tuple[tuple[float, float, float, float], tuple[float, float, float, float]]:
         """Returns the parameters to use for panning the plot.
 
@@ -682,7 +684,7 @@ def get_pan_param(
         return dx, dy
 
     def get_zoom_param(
-        self, plot: BasePlot, pos: QC.QPoint, factor: float
+        self, plot: BasePlot, pos: QPoint, factor: float
     ) -> tuple[tuple[float, float, float, float], tuple[float, float, float, float]]:
         """Returns the parameters to use for zooming on the plot.
 

plotpy/mathutils/colormaps.py

@@ -62,7 +62,7 @@ def load_raw_colormaps_from_json(
 
     Args:
         json_path: absolute path to the json to open. If file is not found, returns an
-        empty dictionary
+         empty dictionary
 
     Returns:
         Dictionnary of colormaps names -> raw colormap sequences
@@ -179,11 +179,11 @@ def build_icon_from_cmap(
         width: icon width
         height: icon height
         orientation: orientation of the colormap in the icon. Can be "h" for horizontal
-        or "v" for vertical
+         or "v" for vertical
         margin: margin around the colormap in the icon. Beware that the margin is
-        included in the given icon size. For example, if margin is 1 and width is 16,
-        the actual colormap width will be 14 (16 - 2 * 1). This was done to prevent
-        interpolation on display.
+         included in the given icon size. For example, if margin is 1 and width is 16,
+         the actual colormap width will be 14 (16 - 2 * 1). This was done to prevent
+         interpolation on display.
     """
 
     padded_width = width - 2 * margin
@@ -233,11 +233,11 @@ def build_icon_from_cmap_name(
         width: icon width
         height: icon height
         orientation: orientation of the colormap in the icon. Can be "h" for horizontal
-        or "v" for vertical
+         or "v" for vertical
         margin: margin around the colormap in the icon. Beware that the margin is
-        included in the given icon size. For example, if margin is 1 and width is 16,
-        the actual colormap width will be 14 (16 - 2 * 1). This was done to prevent
-        interpolation on display.
+         included in the given icon size. For example, if margin is 1 and width is 16,
+         the actual colormap width will be 14 (16 - 2 * 1). This was done to prevent
+         interpolation on display.
 
     Returns:
         QIcon representing the colormap
@@ -253,7 +253,7 @@ def get_cmap(cmap_name: str) -> EditableColormap:
 
     Args:
         cmap_name: colormap name to search in ALL_COLORMAPS. All keys in ALL_COLORMAPS
-        are lower case, so the given name is also lowered.
+         are lower case, so the given name is also lowered.
 
     Returns:
         A CustomQwtLinearColormap instance corresponding to the given name, if no
@@ -270,7 +270,7 @@ def cmap_exists(cmap_name: str, cmap_dict: CmapDictType | None = None) -> bool:
 
     Args:
         cmap_name: colormap name to search in given colormap dictionnary. All keys in
-        the dictionary are lower case, so the given name is also lowered.
+         the dictionary are lower case, so the given name is also lowered.
         cmap_dict: colormap dictionnary to search in. If None, ALL_COLORMAPS is used.
 
     Returns:

plotpy/tools/curve.py

@@ -180,7 +180,7 @@ class SelectPointTool(InteractiveTool):
         icon: Tool icon path. Defaults to None.
         tip: Available tip. Defaults to None.
         end_callback: Callback function taking a Self instance as argument that will
-        be passed when the user stops dragging the point. Defaults to None.
+         be passed when the user stops dragging the point. Defaults to None.
         toolbar_id: Toolbar Id to use. Defaults to DefaultToolbarID.
         marker_style: Marker style. Defaults to None.
         switch_to_default_tool: Wether to use as the default tool or not.

plotpy/tools/image.py

@@ -12,7 +12,6 @@
 from guidata.widgets.arrayeditor import ArrayEditor
 from qtpy import QtCore as QC
 from qtpy import QtWidgets as QW
-from qtpy.QtWidgets import QAction, QActionGroup
 
 from plotpy import io
 from plotpy.config import _
@@ -52,7 +51,8 @@
 from plotpy.widgets.imagefile import exec_image_save_dialog
 
 if TYPE_CHECKING:  # pragma: no cover
-    from qtpy import QtGui as QG
+    from qtpy.QtCore import QEvent
+    from qtpy.QtWidgets import QMenu
 
     from plotpy.events import StatefulEventFilter
     from plotpy.interfaces.items import IBasePlotItem
@@ -327,7 +327,7 @@ def __init__(self, manager: PlotManager) -> None:
         super().__init__(manager, _("Aspect ratio"), tip=None, toolbar_id=None)
         self.action.setEnabled(True)
 
-    def create_action_menu(self, manager: PlotManager) -> QW.QMenu:
+    def create_action_menu(self, manager: PlotManager) -> QMenu:
         """Create and return menu for the tool's action"""
         self.ar_param = AspectRatioParam(_("Aspect ratio"))
         menu = QW.QMenu()
@@ -428,7 +428,7 @@ def update_status(self, plot: BasePlot) -> None:
         item = plot.get_last_active_item(IVoiImageItemType)
         panel = self.manager.get_panel(self.panel_id)
         for action in panel.toolbar.actions():
-            if isinstance(action, QAction):
+            if isinstance(action, QW.QAction):
                 action.setEnabled(item is not None)
 
 
@@ -557,7 +557,7 @@ def __init__(self, manager: PlotManager, toolbar_id=DefaultToolbarID) -> None:
         )
         self.masked_image = None  # associated masked image item
 
-    def create_action_menu(self, manager: PlotManager) -> QW.QMenu:
+    def create_action_menu(self, manager: PlotManager) -> QMenu:
         """Create and return the tool's action menu for a given manager.
 
         Args:
@@ -912,16 +912,16 @@ class RotationCenterTool(InteractiveTool):
     Args:
        manager: PlotManager instance
        toolbar_id: toolbar id to use. Defaults to DefaultToolbarID.. Defaults to
-       DefaultToolbarID.
+        DefaultToolbarID.
        title: tool title. Defaults to None.
        icon: tool icon filename. Defaults to None.
        tip: user tip to be displayed. Defaults to None.
        switch_to_default_tool: Flag to switch to default tool. Defaults to True.
        rotation_point_move_with_shape: Flag to move rotation point with shape when it
-       is moved. Defaults to True.
+        is moved. Defaults to True.
        rotation_center: True if image already has a rotation center, False otherwise.
        on_all_items: True if rotation center should be set on all items or False if only
-       on selected ones. Defaults to True.
+        on selected ones. Defaults to True.
 
     """
 
@@ -1006,7 +1006,7 @@ def action_triggered(self, checked: bool) -> None:
         if self.rotation_center and self.filter is not None:
             self.mouse_press(self.filter, QC.QEvent(QC.QEvent.Type.MouseButtonPress))
 
-    def mouse_press(self, filter: StatefulEventFilter, event: QC.QEvent) -> None:
+    def mouse_press(self, filter: StatefulEventFilter, event: QEvent) -> None:
         """We create a new shape if it's the first point
         otherwise we add a new point.