Add missing types to 3D viz docstrings (mne-tools#12242)

Shrecki · Nov 27, 2023 · 476e50d · 476e50d
1 parent 1334bfc
commit 476e50d
Showing 1 changed file with 17 additions and 17 deletions.
diff --git a/mne/viz/backends/_abstract.py b/mne/viz/backends/_abstract.py
@@ -166,11 +166,11 @@ def mesh(
             The scalar valued associated to the vertices.
         vmin : float | None
             vmin is used to scale the colormap.
-            If None, the min of the data will be used
+            If None, the min of the data will be used.
         vmax : float | None
             vmax is used to scale the colormap.
-            If None, the max of the data will be used
-        colormap :
+            If None, the max of the data will be used.
+        colormap : str | np.ndarray | matplotlib.colors.Colormap | None
             The colormap to use.
         interpolate_before_map :
             Enabling makes for a smoother scalars display. Default is True.
@@ -225,17 +225,17 @@ def contour(
             The opacity of the contour.
         vmin : float | None
             vmin is used to scale the colormap.
-            If None, the min of the data will be used
+            If None, the min of the data will be used.
         vmax : float | None
             vmax is used to scale the colormap.
-            If None, the max of the data will be used
-        colormap :
+            If None, the max of the data will be used.
+        colormap : str | np.ndarray | matplotlib.colors.Colormap | None
             The colormap to use.
         normalized_colormap : bool
             Specify if the values of the colormap are between 0 and 1.
         kind : 'line' | 'tube'
             The type of the primitives to use to display the contours.
-        color :
+        color : tuple | str
             The color of the mesh as a tuple (red, green, blue) of float
             values between 0 and 1 or a valid color name (i.e. 'white'
             or 'w').
@@ -270,11 +270,11 @@ def surface(
             The opacity of the surface.
         vmin : float | None
             vmin is used to scale the colormap.
-            If None, the min of the data will be used
+            If None, the min of the data will be used.
         vmax : float | None
             vmax is used to scale the colormap.
-            If None, the max of the data will be used
-        colormap :
+            If None, the max of the data will be used.
+        colormap : str | np.ndarray | matplotlib.colors.Colormap | None
             The colormap to use.
         scalars : ndarray, shape (n_vertices,)
             The scalar valued associated to the vertices.
@@ -354,11 +354,11 @@ def tube(
             The optional scalar data to use.
         vmin : float | None
             vmin is used to scale the colormap.
-            If None, the min of the data will be used
+            If None, the min of the data will be used.
         vmax : float | None
             vmax is used to scale the colormap.
-            If None, the max of the data will be used
-        colormap :
+            If None, the max of the data will be used.
+        colormap : str | np.ndarray | matplotlib.colors.Colormap | None
             The colormap to use.
         opacity : float
             The opacity of the tube(s).
@@ -446,7 +446,7 @@ def quiver3d(
             The optional scalar data to use.
         backface_culling : bool
             If True, enable backface culling on the quiver.
-        colormap :
+        colormap : str | np.ndarray | matplotlib.colors.Colormap | None
             The colormap to use.
         vmin : float | None
             vmin is used to scale the colormap.
@@ -518,15 +518,15 @@ def scalarbar(self, source, color="white", title=None, n_labels=4, bgcolor=None)
 
         Parameters
         ----------
-        source :
+        source
             The object of the scene used for the colormap.
-        color :
+        color : tuple | str
             The color of the label text.
         title : str | None
             The title of the scalar bar.
         n_labels : int | None
             The number of labels to display on the scalar bar.
-        bgcolor :
+        bgcolor : tuple | str
             The color of the background when there is transparency.
         """
         pass