ASCEE/pyqtgraph
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

MNT: escape docstrings that have rst escaping in them

Browse Source
This commit is contained in:
Thomas A Caswell 2019-02-14 16:39:45 -05:00
parent 691da09eb0
commit 4fe90bb215
No known key found for this signature in database
GPG Key ID: BCD928050D713D75
1 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
pyqtgraph/graphicsItems/ROI.py
View File

@ -1102,9 +1102,9 @@ class ROI(GraphicsObject):
return bounds, tr
def getArrayRegion(self, data, img, axes=(0,1), returnMappedCoords=False, **kwds):
"""Use the position and orientation of this ROI relative to an imageItem
r"""Use the position and orientation of this ROI relative to an imageItem
to pull a slice from an array.
=================== ====================================================
**Arguments**
data The array to slice from. Note that this array does
@ -1524,9 +1524,9 @@ class TestROI(ROI):
class RectROI(ROI):
"""
r"""
Rectangular ROI subclass with a single scale handle at the top-right corner.
============== =============================================================
**Arguments**
pos (length-2 sequence) The position of the ROI origin.
@ -1586,11 +1586,13 @@ class LineROI(ROI):
class MultiRectROI(QtGui.QGraphicsObject):
"""
Chain of rectangular ROIs connected by handles.
This is generally used to mark a curved path through
r"""
Chain of rectangular ROIs connected by handles.
This is generally used to mark a curved path through
an image similarly to PolyLineROI. It differs in that each segment
of the chain is rectangular instead of linear and thus has width.
@ -1724,12 +1726,12 @@ class MultiLineROI(MultiRectROI):
MultiRectROI.__init__(self, *args, **kwds)
print("Warning: MultiLineROI has been renamed to MultiRectROI. (and MultiLineROI may be redefined in the future)")
class EllipseROI(ROI):
"""
r"""
Elliptical ROI subclass with one scale handle and one rotation handle.
============== =============================================================
**Arguments**
pos (length-2 sequence) The position of the ROI's origin.
@ -1810,8 +1812,9 @@ class EllipseROI(ROI):
return self.path
class CircleROI(EllipseROI):
"""
r"""
Circular ROI subclass. Behaves exactly as EllipseROI, but may only be scaled
proportionally to maintain its aspect ratio.
@ -1878,13 +1881,13 @@ class PolygonROI(ROI):
sc['angle'] = self.state['angle']
return sc
class PolyLineROI(ROI):
"""
r"""
Container class for multiple connected LineSegmentROIs.
This class allows the user to draw paths of multiple line segments.
============== =============================================================
**Arguments**
positions (list of length-2 sequences) The list of points in the path.
@ -2076,9 +2079,9 @@ class PolyLineROI(ROI):
class LineSegmentROI(ROI):
"""
r"""
ROI subclass with two freely-moving handles defining a line.
============== =============================================================
**Arguments**
positions (list of two length-2 sequences) The endpoints of the line