From f0071a09dc2eb5c69fdf0b5253498c29219adf79 Mon Sep 17 00:00:00 2001 From: Luke Campagnola Date: Tue, 14 Jun 2016 22:02:05 -0700 Subject: [PATCH] docstring update --- pyqtgraph/graphicsItems/ROI.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/pyqtgraph/graphicsItems/ROI.py b/pyqtgraph/graphicsItems/ROI.py index 4cee274e..51853c61 100644 --- a/pyqtgraph/graphicsItems/ROI.py +++ b/pyqtgraph/graphicsItems/ROI.py @@ -215,15 +215,20 @@ class ROI(GraphicsObject): def setPos(self, pos, y=None, update=True, finish=True): """Set the position of the ROI (in the parent's coordinate system). - By default, this will cause both sigRegionChanged and sigRegionChangeFinished to be emitted. - If finish is False, then sigRegionChangeFinished will not be emitted. You can then use - stateChangeFinished() to cause the signal to be emitted after a series of state changes. + Accepts either separate (x, y) arguments or a single :class:`Point` or + ``QPointF`` argument. - If update is False, the state change will be remembered but not processed and no signals + By default, this method causes both ``sigRegionChanged`` and + ``sigRegionChangeFinished`` to be emitted. If *finish* is False, then + ``sigRegionChangeFinished`` will not be emitted. You can then use + stateChangeFinished() to cause the signal to be emitted after a series + of state changes. + + If *update* is False, the state change will be remembered but not processed and no signals will be emitted. You can then use stateChanged() to complete the state change. This allows multiple change functions to be called sequentially while minimizing processing overhead - and repeated signals. Setting update=False also forces finish=False. + and repeated signals. Setting ``update=False`` also forces ``finish=False``. """ if y is None: pos = Point(pos)