Skip to content

Commit 1db3afd

Browse files
committed
variable names should have single backtick
1 parent 0021cb7 commit 1db3afd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/source/api_reference/graphicsItems/imageitem.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ adjustments, or with :class:`~pyqtgraph.HistogramLUTItem` or
3131
table used to display the image.
3232

3333
An image can be placed into a plot area of a given extent directly through the
34-
:meth:`ImageItem.setRect <pyqtgraph.ImageItem.setRect>` method or the ``rect`` keyword.
34+
:meth:`ImageItem.setRect <pyqtgraph.ImageItem.setRect>` method or the `rect` keyword.
3535
This is internally realized through assigning a :class:`QTransform`. For other
3636
translation, scaling or rotations effects that persist for all later image data, the
3737
user can also directly define and assign such a transform, as shown in the example
@@ -43,7 +43,7 @@ Performance
4343
-----------
4444

4545
The performance of :class:`~pyqtgraph.ImageItem` can vary *significantly* based on
46-
attributes of the ``image``, ``levels`` and ``lut`` input arguments. It should not be
46+
attributes of the `image`, `levels` and `lut` input arguments. It should not be
4747
assumed that the default parameters are the most performant, as the default values are
4848
largely there to preserve backwards compatibility.
4949

@@ -55,12 +55,12 @@ The following guidance should be observed if performance is an important factor
5555
:python:`pyqtgraph.setConfigOption('imageAxisOrder', 'row-major')`
5656

5757
* Use C-contiguous image data.
58-
* For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` ``image``
58+
* For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` `image`
5959
dtype.
6060
* For 4-channel data, use `uint8` or `uint16` with :python:`levels=None`.
61-
* ``levels`` should be set to either to ``None`` or to single channel ``[min, max]``
61+
* `levels` should be set to either to ``None`` or to single channel ``[min, max]``
6262

63-
* Not setting ``levels`` will trigger autoLevels sampling
63+
* Not setting `levels` will trigger autoLevels sampling
6464

6565
* If using LUTs (lookup tables), ensure they have a dtype of `uint8` and have 256
6666
points or less. That can be accomplished with calling:
@@ -69,7 +69,7 @@ The following guidance should be observed if performance is an important factor
6969
* :func:`ImageItem.setLookupTable <pyqtgraph.ImageItem.setLookupTable>` with
7070
:python:`ColorMap.getLookupTable(nPts=256)` (default is :python:`nPts=512`)
7171

72-
* For floating point ``image`` arrays, prefer `float32` dtype to `float64` and avoid
72+
* For floating point `image` arrays, prefer `float32` dtype to `float64` and avoid
7373
``NaN`` values.
7474
* Enable Numba with :python:`pyqtgraph.setConfigOption('useNumba', True)`
7575

0 commit comments

Comments
 (0)