apply ixjlyons feedback

Author: j9ac9k

doc/source/api_reference/graphicsItems/imageitem.rst

@@ -47,32 +47,32 @@ largely there to preserve backwards compatibility.
 
 The following guidance should be observed if performance is an important factor
 
-    * Instantiate :class:`~pyqtgraph.ImageItem` with :python:`axisOrder='row-major'`
-      
-      * Alternatively, set the global configuration optionally
-        :python:`pyqtgraph.setConfigOption('imageAxisOrder', 'row-major')`
-
-    * Use C-contiguous image data.
-    * For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` 
-      ``image`` dtype.
-    * For 4-channel data, use `uint8` or `uint16` with :python":`levels=None`.
-    * ``levels`` should be single channel (if 1 or 3 channel data).
-      
-      * Setting :python:`levels=None` will trigger autoLevels sampling, and thus should
-        be avoided if possible.
-
-    * If using LUTs (lookup tables), ensure they have a dtype of `uint8` and have 256
-      points or less, and that. That can be accomplished with calling:
-    
-      * :func:`ImageItem.setColorMap <pyqtgraph.ImageItem.setColorMap>` or
-      * :func:`ImageItem.setLookupTable <pyqtgraph.ImageItem.setLookupTable>` with 
-        :python:`ColorMap.getLookupTable(nPts=256)` (default is :python:`nPts=512`)
-
-    * For floating point ``image`` arrays, prefer `float32` dtype to `float64`
-      and avoid ``NaN`` values.
-    * Enable Numba with :python:`pyqtgraph.setConfigOption('useNumba', True)`
-
-      * JIT compilation will only accelerate repeated image display.
+* Instantiate :class:`~pyqtgraph.ImageItem` with :python:`axisOrder='row-major'`
+  
+  * Alternatively, set the global configuration optionally
+    :python:`pyqtgraph.setConfigOption('imageAxisOrder', 'row-major')`
+
+* Use C-contiguous image data.
+* For 1 or 3 channel data, use `uint8`, `uint16`, `float32`, or `float64` 
+  ``image`` dtype.
+* For 4-channel data, use `uint8` or `uint16` with :python":`levels=None`.
+* ``levels`` should be single channel (if 1 or 3 channel data).
+  
+  * Setting :python:`levels=None` will trigger autoLevels sampling, and thus should
+    be avoided if possible.
+
+* If using LUTs (lookup tables), ensure they have a dtype of `uint8` and have 256
+  points or less, and that. That can be accomplished with calling:
+
+  * :func:`ImageItem.setColorMap <pyqtgraph.ImageItem.setColorMap>` or
+  * :func:`ImageItem.setLookupTable <pyqtgraph.ImageItem.setLookupTable>` with 
+    :python:`ColorMap.getLookupTable(nPts=256)` (default is :python:`nPts=512`)
+
+* For floating point ``image`` arrays, prefer `float32` dtype to `float64`
+  and avoid ``NaN`` values.
+* Enable Numba with :python:`pyqtgraph.setConfigOption('useNumba', True)`
+
+  * JIT compilation will only accelerate repeated image display.
 
 Internally, pyqtgraph attempts to directly construct a :class:`QImage` using a
 combination of :class:`QImage.Format <QImage.Format>` options and

pyqtgraph/graphicsItems/ImageItem.py

@@ -45,8 +45,8 @@ def __init__(self, image=None, **kargs):
             Arguments directed to :func:`setImage` and :func:`setOpts`
         See Also
         --------
-        :func:`setImage`
-        :func:`setOpts`
+        setImage : for descriptions of available keyword arguments
+        setOpts : for information on supported formats
 
         """
         super().__init__()
@@ -158,15 +158,10 @@ def setLevels(self, levels: npt.ArrayLike, update: bool=True):
                 sets individual scaling for RGB values. Not compatible with lookup tables.
         update : bool, optional
             Controls if image immediately updates to reflect the new levels, default True
-        
-        Notes
-        -----
-        See :func:`makeARGB <pyqtgraph.makeARGB>` for more details on how levels are
-        applied.
 
         See Also
         --------
-        :func:`pyqtgraph.functions.makeARGB`
+        pyqtgraph.functions.makeARGB : for more details on how levels are applied.
         """
         if self._xp is None:
             self.levels = levels