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

In list tables "**Arguments**", "Arguments:" changed to **Arguments:**

Browse Source
This commit is contained in:
tommy3001 2014-02-03 21:13:10 +01:00
parent 67685d80bc
commit 92d7bbe18e
24 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pyqtgraph/canvas/CanvasItem.py
View File

@ -431,7 +431,7 @@ class CanvasItem(QtCore.QObject):
def selectionChanged(self, sel, multi):
"""
Inform the item that its selection state has changed.
Arguments:
**Arguments:**
sel: bool, whether the item is currently selected
multi: bool, whether there are multiple items currently selected
"""

4
pyqtgraph/colormap.py
View File

@ -53,7 +53,7 @@ class ColorMap(object):
def __init__(self, pos, color, mode=None):
"""
========= ==============================================================
Arguments
**Arguments:**
pos Array of positions where each color is defined
color Array of RGBA colors.
Integer data types are interpreted as 0-255; float data types
@ -194,7 +194,7 @@ class ColorMap(object):
Return an RGB(A) lookup table (ndarray).
============= ============================================================================
**Arguments**
**Arguments:**
start The starting value in the lookup table (default=0.0)
stop The final value in the lookup table (default=1.0)
nPts The number of points in the returned lookup table.

2
pyqtgraph/console/Console.py
View File

@ -32,7 +32,7 @@ class ConsoleWidget(QtGui.QWidget):
def __init__(self, parent=None, namespace=None, historyFile=None, text=None, editor=None):
"""
============ ============================================================================
Arguments:
**Arguments:**
namespace dictionary containing the initial variables present in the default namespace
historyFile optional file for storing command history
text initial text to display in the console window

2
pyqtgraph/debug.py
View File

@ -828,7 +828,7 @@ def typeStr(obj):
def searchRefs(obj, *args):
"""Pseudo-interactive function for tracing references backward.
Arguments:
**Arguments:**
obj: The initial object from which to start searching
args: A set of string or int arguments.
each integer selects one of obj's referrers to be the new 'obj'

2
pyqtgraph/dockarea/DockArea.py
View File

@ -37,7 +37,7 @@ class DockArea(Container, QtGui.QWidget, DockDrop):
"""Adds a dock to this area.
=========== =================================================================
Arguments:
**Arguments:**
dock The new Dock object to add. If None, then a new Dock will be
created.
position 'bottom', 'top', 'left', 'right', 'above', or 'below'

2
pyqtgraph/flowchart/Node.py
View File

@ -37,7 +37,7 @@ class Node(QtCore.QObject):
def __init__(self, name, terminals=None, allowAddInput=False, allowAddOutput=False, allowRemove=True):
"""
============== ============================================================
Arguments
**Arguments:**
name The name of this specific node instance. It can be any
string, but must be unique within a flowchart. Usually,
we simply let the flowchart decide on a name when calling

2
pyqtgraph/flowchart/NodeLibrary.py
View File

@ -26,7 +26,7 @@ class NodeLibrary:
Register a new node type. If the type's name is already in use,
an exception will be raised (unless override=True).
Arguments:
**Arguments:**
nodeClass - a subclass of Node (must have typ.nodeName)
paths - list of tuples specifying the location(s) this

8
pyqtgraph/functions.py
View File

@ -388,7 +388,7 @@ def affineSlice(data, shape, origin, vectors, axes, order=1, returnCoords=False,
For a graphical interface to this function, see :func:`ROI.getArrayRegion <pyqtgraph.ROI.getArrayRegion>`
============== ====================================================================================================
Arguments:
**Arguments:**
*data* (ndarray) the original dataset
*shape* the shape of the slice to take (Note the return value may have more dimensions than len(shape))
*origin* the location in the original dataset that will become the origin of the sliced data.
@ -752,7 +752,7 @@ def makeARGB(data, lut=None, levels=None, scale=None, useRGBA=False):
Both stages are optional.
============ ==================================================================================
Arguments:
**Arguments:**
data numpy array of int/float types. If
levels List [min, max]; optionally rescale data before converting through the
lookup table. The data is rescaled such that min->0 and max->*scale*::
@ -888,7 +888,7 @@ def makeQImage(imgData, alpha=None, copy=True, transpose=True):
freeing that memory while the image is in use.
=========== ===================================================================
Arguments:
**Arguments:**
imgData Array of data to convert. Must have shape (width, height, 3 or 4)
and dtype=ubyte. The order of values in the 3rd axis must be
(b, g, r, a).
@ -1241,7 +1241,7 @@ def isocurve(data, level, connected=False, extendToEdge=False, path=False):
Generate isocurve from 2D data using marching squares algorithm.
============= =========================================================
Arguments
**Arguments:**
data 2D numpy array of scalar values
level The level at which to generate an isosurface
connected If False, return a single long list of point pairs

2
pyqtgraph/graphicsItems/ArrowItem.py
View File

@ -48,7 +48,7 @@ class ArrowItem(QtGui.QGraphicsPathItem):
All arguments are optional:
================= =================================================
Keyword Arguments
**Keyword Arguments:**
angle Orientation of the arrow in degrees. Default is
0; arrow pointing to the left.
headLen Length of the arrow head, from tip to base.

26
pyqtgraph/graphicsItems/GradientEditorItem.py
View File

@ -36,7 +36,7 @@ class TickSliderItem(GraphicsWidget):
def __init__(self, orientation='bottom', allowAdd=True, **kargs):
"""
============= =================================================================================
**Arguments**
**Arguments:**
orientation Set the orientation of the gradient. Options are: 'left', 'right'
'top', and 'bottom'.
allowAdd Specifies whether ticks can be added to the item by the user.
@ -104,7 +104,7 @@ class TickSliderItem(GraphicsWidget):
"""Set the orientation of the TickSliderItem.
============= ===================================================================
**Arguments**
**Arguments:**
orientation Options are: 'left', 'right', 'top', 'bottom'
The orientation option specifies which side of the slider the
ticks are on, as well as whether the slider is vertical ('right'
@ -137,7 +137,7 @@ class TickSliderItem(GraphicsWidget):
Add a tick to the item.
============= ==================================================================
**Arguments**
**Arguments:**
x Position where tick should be added.
color Color of added tick. If color is not specified, the color will be
white.
@ -266,7 +266,7 @@ class TickSliderItem(GraphicsWidget):
"""Set the color of the specified tick.
============= ==================================================================
**Arguments**
**Arguments:**
tick Can be either an integer corresponding to the index of the tick
or a Tick object. Ex: if you had a slider with 3 ticks and you
wanted to change the middle tick, the index would be 1.
@ -285,7 +285,7 @@ class TickSliderItem(GraphicsWidget):
Set the position (along the slider) of the tick.
============= ==================================================================
**Arguments**
**Arguments:**
tick Can be either an integer corresponding to the index of the tick
or a Tick object. Ex: if you had a slider with 3 ticks and you
wanted to change the middle tick, the index would be 1.
@ -306,7 +306,7 @@ class TickSliderItem(GraphicsWidget):
"""Return the value (from 0.0 to 1.0) of the specified tick.
============= ==================================================================
**Arguments**
**Arguments:**
tick Can be either an integer corresponding to the index of the tick
or a Tick object. Ex: if you had a slider with 3 ticks and you
wanted the value of the middle tick, the index would be 1.
@ -320,7 +320,7 @@ class TickSliderItem(GraphicsWidget):
"""Return the Tick object at the specified index.
============= ==================================================================
**Arguments**
**Arguments:**
tick An integer corresponding to the index of the desired tick. If the
argument is not an integer it will be returned unchanged.
============= ==================================================================
@ -367,7 +367,7 @@ class GradientEditorItem(TickSliderItem):
All arguments are passed to :func:`TickSliderItem.__init__ <pyqtgraph.TickSliderItem.__init__>`
============= =================================================================================
**Arguments**
**Arguments:**
orientation Set the orientation of the gradient. Options are: 'left', 'right'
'top', and 'bottom'.
allowAdd Default is True. Specifies whether ticks can be added to the item.
@ -446,7 +446,7 @@ class GradientEditorItem(TickSliderItem):
Set the orientation of the GradientEditorItem.
============= ===================================================================
**Arguments**
**Arguments:**
orientation Options are: 'left', 'right', 'top', 'bottom'
The orientation option specifies which side of the gradient the
ticks are on, as well as whether the gradient is vertical ('right'
@ -589,7 +589,7 @@ class GradientEditorItem(TickSliderItem):
Return a color for a given value.
============= ==================================================================
**Arguments**
**Arguments:**
x Value (position on gradient) of requested color.
toQColor If true, returns a QColor object, else returns a (r,g,b,a) tuple.
============= ==================================================================
@ -649,7 +649,7 @@ class GradientEditorItem(TickSliderItem):
Return an RGB(A) lookup table (ndarray).
============= ============================================================================
**Arguments**
**Arguments:**
nPts The number of points in the returned lookup table.
alpha True, False, or None - Specifies whether or not alpha values are included
in the table.If alpha is None, alpha will be automatically determined.
@ -703,7 +703,7 @@ class GradientEditorItem(TickSliderItem):
Add a tick to the gradient. Return the tick.
============= ==================================================================
**Arguments**
**Arguments:**
x Position where tick should be added.
color Color of added tick. If color is not specified, the color will be
the color of the gradient at the specified position.
@ -749,7 +749,7 @@ class GradientEditorItem(TickSliderItem):
Restore the gradient specified in state.
============= ====================================================================
**Arguments**
**Arguments:**
state A dictionary with same structure as those returned by
:func:`saveState <pyqtgraph.GradientEditorItem.saveState>`

2
pyqtgraph/graphicsItems/InfiniteLine.py
View File

@ -29,7 +29,7 @@ class InfiniteLine(GraphicsObject):
def __init__(self, pos=None, angle=90, pen=None, movable=False, bounds=None):
"""
============= ==================================================================
**Arguments**
**Arguments:**
pos Position of the line. This can be a QPointF or a single value for
vertical/horizontal lines.
angle Angle of line in degrees. 0 is horizontal, 90 is vertical.

4
pyqtgraph/graphicsItems/IsocurveItem.py
View File

@ -19,7 +19,7 @@ class IsocurveItem(GraphicsObject):
Create a new isocurve item.
============= ===============================================================
**Arguments**
**Arguments:**
data A 2-dimensional ndarray. Can be initialized as None, and set
later using :func:`setData <pyqtgraph.IsocurveItem.setData>`
level The cutoff value at which to draw the isocurve.
@ -46,7 +46,7 @@ class IsocurveItem(GraphicsObject):
Set the data/image to draw isocurves for.
============= ========================================================================
**Arguments**
**Arguments:**
data A 2-dimensional ndarray.
level The cutoff value at which to draw the curve. If level is not specified,
the previously set level is used.

4
pyqtgraph/graphicsItems/LinearRegionItem.py
View File

@ -31,7 +31,7 @@ class LinearRegionItem(UIGraphicsItem):
"""Create a new LinearRegionItem.
============= =====================================================================
**Arguments**
**Arguments:**
values A list of the positions of the lines in the region. These are not
limits; limits can be set by specifying bounds.
orientation Options are LinearRegionItem.Vertical or LinearRegionItem.Horizontal.
@ -90,7 +90,7 @@ class LinearRegionItem(UIGraphicsItem):
"""Set the values for the edges of the region.
============= ==============================================
**Arguments**
**Arguments:**
rgn A list or tuple of the lower and upper values.
============= ==============================================
"""

4
pyqtgraph/graphicsItems/PlotItem/PlotItem.py
View File

@ -102,7 +102,7 @@ class PlotItem(GraphicsWidget):
Any extra keyword arguments are passed to PlotItem.plot().
============== ==========================================================================================
**Arguments**
**Arguments:**
*title* Title to display at the top of the item. Html is allowed.
*labels* A dictionary specifying the axis labels to display::
@ -1113,7 +1113,7 @@ class PlotItem(GraphicsWidget):
Set the label for an axis. Basic HTML formatting is allowed.
============= =================================================================
**Arguments**
**Arguments:**
axis must be one of 'left', 'bottom', 'right', or 'top'
text text to display along the axis. HTML allowed.
units units to display after the title. If units are given,

2
pyqtgraph/graphicsItems/TextItem.py
View File

@ -10,7 +10,7 @@ class TextItem(UIGraphicsItem):
def __init__(self, text='', color=(200,200,200), html=None, anchor=(0,0), border=None, fill=None, angle=0):
"""
=========== =================================================================================
Arguments:
**Arguments:**
*text* The text to display
*color* The color of the text (any format accepted by pg.mkColor)
*html* If specified, this overrides both *text* and *color*

4
pyqtgraph/graphicsItems/VTickGroup.py
View File

@ -20,7 +20,7 @@ class VTickGroup(UIGraphicsItem):
def __init__(self, xvals=None, yrange=None, pen=None):
"""
============= ===================================================================
**Arguments**
**Arguments:**
xvals A list of x values (in data coordinates) at which to draw ticks.
yrange A list of [low, high] limits for the tick. 0 is the bottom of
the view, 1 is the top. [0.8, 1] would draw ticks in the top
@ -57,7 +57,7 @@ class VTickGroup(UIGraphicsItem):
"""Set the x values for the ticks.
============= =====================================================================
**Arguments**
**Arguments:**
vals A list of x values (in data/plot coordinates) at which to draw ticks.
============= =====================================================================
"""

4
pyqtgraph/graphicsItems/ViewBox/ViewBox.py
View File

@ -72,7 +72,7 @@ class ViewBox(GraphicsWidget):
def __init__(self, parent=None, border=None, lockAspect=False, enableMouse=True, invertY=False, enableMenu=True, name=None):
"""
============= =============================================================
**Arguments**
**Arguments:**
*parent* (QGraphicsWidget) Optional parent widget
*border* (QPen) Do draw a border around the view, give any
single argument accepted by :func:`mkPen <pyqtgraph.mkPen>`
@ -404,7 +404,7 @@ class ViewBox(GraphicsWidget):
Must specify at least one of *rect*, *xRange*, or *yRange*.
================== =====================================================================
**Arguments**
**Arguments:**
*rect* (QRectF) The full range that should be visible in the view box.
*xRange* (min,max) The range that should be visible along the x-axis.
*yRange* (min,max) The range that should be visible along the y-axis.

2
pyqtgraph/multiprocess/parallelizer.py
View File

@ -40,7 +40,7 @@ class Parallelize(object):
def __init__(self, tasks=None, workers=None, block=True, progressDialog=None, randomReseed=True, **kwds):
"""
=============== ===================================================================
Arguments:
**Arguments:**
tasks list of objects to be processed (Parallelize will determine how to
distribute the tasks). If unspecified, then each worker will receive
a single task with a unique id number.

2
pyqtgraph/multiprocess/processes.py
View File

@ -39,7 +39,7 @@ class Process(RemoteEventHandler):
def __init__(self, name=None, target=None, executable=None, copySysPath=True, debug=False, timeout=20, wrapStdout=None):
"""
============ =============================================================
Arguments:
**Arguments:**
name Optional name for this process used when printing messages
from the remote process.
target Optional function to call after starting remote process.

2
pyqtgraph/multiprocess/remoteproxy.py
View File

@ -300,7 +300,7 @@ class RemoteEventHandler(object):
as it describes the internal protocol used to communicate between processes)
========== ====================================================================
Arguments:
**Arguments:**
request String describing the type of request being sent (see below)
reqId Integer uniquely linking a result back to the request that generated
it. (most requests leave this blank)

2
pyqtgraph/opengl/items/GLLinePlotItem.py
View File

@ -27,7 +27,7 @@ class GLLinePlotItem(GLGraphicsItem):
colors unchanged, etc.
==================== ==================================================
Arguments:
**Arguments:**
------------------------------------------------------------------------
pos (N,3) array of floats specifying point locations.
color (N,4) array of floats (0.0-1.0) or

2
pyqtgraph/opengl/items/GLScatterPlotItem.py
View File

@ -28,7 +28,7 @@ class GLScatterPlotItem(GLGraphicsItem):
colors unchanged, etc.
==================== ==================================================
Arguments:
**Arguments:**
------------------------------------------------------------------------
pos (N,3) array of floats specifying point locations.
color (N,4) array of floats (0.0-1.0) specifying

4
pyqtgraph/parametertree/Parameter.py
View File

@ -108,7 +108,7 @@ class Parameter(QtCore.QObject):
by most Parameter subclasses.
================= =========================================================
Keyword Arguments
**Keyword Arguments:**
name The name to give this Parameter. This is the name that
will appear in the left-most column of a ParameterTree
for this Parameter.
@ -676,7 +676,7 @@ class Parameter(QtCore.QObject):
Called when the state of any sub-parameter has changed.
========== ================================================================
Arguments:
**Arguments:**
param The immediate child whose tree state has changed.
note that the change may have originated from a grandchild.
changes List of tuples describing all changes that have been made

2
pyqtgraph/widgets/GraphicsView.py
View File

@ -51,7 +51,7 @@ class GraphicsView(QtGui.QGraphicsView):
def __init__(self, parent=None, useOpenGL=None, background='default'):
"""
============ ============================================================
Arguments:
**Arguments:**
parent Optional parent widget
useOpenGL If True, the GraphicsView will use OpenGL to do all of its
rendering. This can improve performance on some systems,