From ae64ac79a6158f1f6287d63bc8b2e7b3553adfbb Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Tue, 13 Sep 2022 16:13:46 -0400 Subject: [PATCH] Doc str tweaks --- piker/ui/_annotate.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/piker/ui/_annotate.py b/piker/ui/_annotate.py index 6e0e84d1..5cae0bdd 100644 --- a/piker/ui/_annotate.py +++ b/piker/ui/_annotate.py @@ -32,8 +32,10 @@ def mk_marker_path( style: str, ) -> QGraphicsPathItem: - """Add a marker to be displayed on the line wrapped in a ``QGraphicsPathItem`` - ready to be placed using scene coordinates (not view). + """ + Add a marker to be displayed on the line wrapped in + a ``QGraphicsPathItem`` ready to be placed using scene coordinates + (not view). **Arguments** style String indicating the style of marker to add: @@ -87,7 +89,8 @@ def mk_marker_path( class LevelMarker(QGraphicsPathItem): - '''An arrow marker path graphich which redraws itself + ''' + An arrow marker path graphich which redraws itself to the specified view coordinate level on each paint cycle. ''' @@ -154,7 +157,8 @@ class LevelMarker(QGraphicsPathItem): # level: float, ) -> None: - '''Show a pp off-screen indicator for a level label. + ''' + Show a pp off-screen indicator for a level label. This is like in fps games where you have a gps "nav" indicator but your teammate is outside the range of view, except in 2D, on @@ -211,7 +215,8 @@ class LevelMarker(QGraphicsPathItem): w: QtWidgets.QWidget ) -> None: - '''Core paint which we override to always update + ''' + Core paint which we override to always update our marker position in scene coordinates from a view cooridnate "level".