deploy stub files [ci skip] (#247)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: github-actions[bot]

mne_icalabel/annotation/bids.pyi

@@ -1,4 +1,4 @@
-from pathlib import Path as Path
+from pathlib import Path
 
 from mne.preprocessing import ICA
 
@@ -16,9 +16,9 @@ def write_components_tsv(ica: ICA, fname: str | Path):
     Parameters
     ----------
     ica : ICA
-        An instance of the fitted ICA.
+    An instance of the fitted ICA.
     fname : str | Path
-        The output filename.
+    The output filename.
 
     Notes
     -----
@@ -45,20 +45,20 @@ def mark_component(
     Parameters
     ----------
     component : int
-        The component to mark.
+    The component to mark.
     fname : Union[str, Path]
-        The filename for the BIDS filepath.
+    The filename for the BIDS filepath.
     method : str
-        The method to use. Must be 'manual', or one of ['iclabel'].
+    The method to use. Must be 'manual', or one of ['iclabel'].
     label : str
-        The label of the ICA component. Must be one of ['brain',
-        'muscle artifact', 'eye blink', 'heart beat', 'line noise',
-        'channel noise', 'other'].
+    The label of the ICA component. Must be one of ['brain',
+    'muscle artifact', 'eye blink', 'heart beat', 'line noise',
+    'channel noise', 'other'].
     author : str
-        The annotating author.
+    The annotating author.
     strict_label : bool
-        Whether to raise an error if ``label`` is not an accepted value.
-        Default is True.
+    Whether to raise an error if ``label`` is not an accepted value.
+    Default is True.
 
     Notes
     -----

mne_icalabel/config.pyi

@@ -1,4 +1,4 @@
-from collections.abc import Callable
+from collections.abc import Callable as Callable
 
 from .iclabel import iclabel_label_components as iclabel_label_components
 

mne_icalabel/datasets/icalabel/icalabel.pyi

@@ -18,30 +18,30 @@ def data_path(
     Parameters
     ----------
     path : None | str
-        Location of where to look for the dataset.
-        If None, the environment variable or config parameter is used.
-        If it doesn’t exist, the “~/mne_data” directory is used.
-        If the dataset is not found under the given path,
-        the data will be automatically downloaded to the specified folder.
+    Location of where to look for the dataset.
+    If None, the environment variable or config parameter is used.
+    If it doesn’t exist, the “~/mne_data” directory is used.
+    If the dataset is not found under the given path,
+    the data will be automatically downloaded to the specified folder.
     force_update : bool
-        Force update of the dataset even if a local copy exists.
+    Force update of the dataset even if a local copy exists.
     update_path : bool
-        If True, set the MNE_DATASETS_FNIRSMOTORGROUP_PATH in
-        mne-python config to the given path.
+    If True, set the MNE_DATASETS_FNIRSMOTORGROUP_PATH in
+    mne-python config to the given path.
     download : bool
-        If False and the dataset has not been downloaded yet,
-        it will not be downloaded and the path will be returned
-        as ``‘’`` (empty string). This is mostly used for debugging purposes
-        and can be safely ignored by most users.
+    If False and the dataset has not been downloaded yet,
+    it will not be downloaded and the path will be returned
+    as ``‘’`` (empty string). This is mostly used for debugging purposes
+    and can be safely ignored by most users.
 
     verbose : bool | str | int | None
-        Control verbosity of the logging output. If ``None``, use the default
-        verbosity level. See the :ref:`logging documentation <tut-logging>` and
-        :func:`mne.verbose` for details. Should only be passed as a keyword
-        argument.
+    Control verbosity of the logging output. If ``None``, use the default
+    verbosity level. See the :ref:`logging documentation <tut-logging>` and
+    :func:`mne.verbose` for details. Should only be passed as a keyword
+    argument.
 
     Returns
     -------
     path : Path
-        Path to dataset directory.
+    Path to dataset directory.
     """

mne_icalabel/features/topomap.pyi

@@ -20,42 +20,42 @@ def get_topomaps(
     Parameters
     ----------
     ica : ICA
-        MNE `~mne.preprocessing.ICA` decomposition.
+    MNE `~mne.preprocessing.ICA` decomposition.
     picks : int | list of int | slice | None
-        Indices of the independent components (ICs) to select.
-        If an integer, represents the index of the IC to pick.
-        Multiple ICs can be selected using a list of int or a slice.
-        The indices are 0-indexed, so ``picks=1`` will pick the second IC: ``ICA001``.
-        ``None`` (default) will pick all independent components in the order fitted.
+    Indices of the independent components (ICs) to select.
+    If an integer, represents the index of the IC to pick.
+    Multiple ICs can be selected using a list of int or a slice.
+    The indices are 0-indexed, so ``picks=1`` will pick the second IC: ``ICA001``.
+    ``None`` (default) will pick all independent components in the order fitted.
     res : int
-        The resolution of the square topographic map (in pixels).
+    The resolution of the square topographic map (in pixels).
     image_interp : str
-        The image interpolation to be used. All matplotlib options are
-        accepted.
+    The image interpolation to be used. All matplotlib options are
+    accepted.
     border : float | 'mean'
-        Value to extrapolate to on the topomap borders. If ``'mean'`` (default),
-        then each extrapolated point has the average value of its neighbours.
+    Value to extrapolate to on the topomap borders. If ``'mean'`` (default),
+    then each extrapolated point has the average value of its neighbours.
     extrapolate : str
-        Options:
+    Options:
 
-        - ``'box'``
-            Extrapolate to four points placed to form a square encompassing all
-            data points, where each side of the square is three times the range
-            of the data in the respective dimension.
-        - ``'local'`` (default for MEG sensors)
-            Extrapolate only to nearby points (approximately to points closer than
-            median inter-electrode distance). This will also set the
-            mask to be polygonal based on the convex hull of the sensors.
-        - ``'head'`` (default for non-MEG sensors)
-            Extrapolate out to the edges of the clipping circle. This will be on
-            the head circle when the sensors are contained within the head circle,
-            but it can extend beyond the head when sensors are plotted outside
-            the head circle.
+    - ``'box'``
+        Extrapolate to four points placed to form a square encompassing all
+        data points, where each side of the square is three times the range
+        of the data in the respective dimension.
+    - ``'local'`` (default for MEG sensors)
+        Extrapolate only to nearby points (approximately to points closer than
+        median inter-electrode distance). This will also set the
+        mask to be polygonal based on the convex hull of the sensors.
+    - ``'head'`` (default for non-MEG sensors)
+        Extrapolate out to the edges of the clipping circle. This will be on
+        the head circle when the sensors are contained within the head circle,
+        but it can extend beyond the head when sensors are plotted outside
+        the head circle.
 
     Returns
     -------
     topomaps : dict of array of shape (n_components, n_pixels, n_pixels)
-        Dictionary of ICs topographic maps for each channel type.
+    Dictionary of ICs topographic maps for each channel type.
     """
 
 @fill_doc
@@ -72,37 +72,37 @@ def _get_topomap_array(
     Parameters
     ----------
     data : array of shape (n_channels,)
-        The data points used to generate the topographic map.
+    The data points used to generate the topographic map.
     info : Info
-        Instance of `mne.Info` with the montage associated with the ``(n_channels,)``
-        points.
+    Instance of `mne.Info` with the montage associated with the ``(n_channels,)``
+    points.
     res : int
-        The resolution of the square topographic map (in pixels).
+    The resolution of the square topographic map (in pixels).
     image_interp : str
-        The image interpolation to be used. All matplotlib options are
-        accepted.
+    The image interpolation to be used. All matplotlib options are
+    accepted.
     border : float | 'mean'
-        Value to extrapolate to on the topomap borders. If ``'mean'`` (default),
-        then each extrapolated point has the average value of its neighbours.
+    Value to extrapolate to on the topomap borders. If ``'mean'`` (default),
+    then each extrapolated point has the average value of its neighbours.
     extrapolate : str
-        Options:
+    Options:
 
-        - ``'box'``
-            Extrapolate to four points placed to form a square encompassing all
-            data points, where each side of the square is three times the range
-            of the data in the respective dimension.
-        - ``'local'`` (default for MEG sensors)
-            Extrapolate only to nearby points (approximately to points closer than
-            median inter-electrode distance). This will also set the
-            mask to be polygonal based on the convex hull of the sensors.
-        - ``'head'`` (default for non-MEG sensors)
-            Extrapolate out to the edges of the clipping circle. This will be on
-            the head circle when the sensors are contained within the head circle,
-            but it can extend beyond the head when sensors are plotted outside
-            the head circle.
+    - ``'box'``
+        Extrapolate to four points placed to form a square encompassing all
+        data points, where each side of the square is three times the range
+        of the data in the respective dimension.
+    - ``'local'`` (default for MEG sensors)
+        Extrapolate only to nearby points (approximately to points closer than
+        median inter-electrode distance). This will also set the
+        mask to be polygonal based on the convex hull of the sensors.
+    - ``'head'`` (default for non-MEG sensors)
+        Extrapolate out to the edges of the clipping circle. This will be on
+        the head circle when the sensors are contained within the head circle,
+        but it can extend beyond the head when sensors are plotted outside
+        the head circle.
 
     Returns
     -------
     topomap : array of shape (n_pixels, n_pixels)
-        Topographic map array.
+    Topographic map array.
     """

mne_icalabel/gui/__init__.pyi

@@ -6,17 +6,17 @@ def label_ica_components(inst, ica: ICA, show: bool = True, block: bool = False)
     Parameters
     ----------
     inst : Raw | Epochs
-        `~mne.io.Raw` or `~mne.Epochs` instance used to fit the `~mne.preprocessing.ICA`
-        decomposition.
+    `~mne.io.Raw` or `~mne.Epochs` instance used to fit the `~mne.preprocessing.ICA`
+    decomposition.
     ica : ICA
-        The ICA object fitted on ``inst``.
+    The ICA object fitted on ``inst``.
     show : bool
-        Show the GUI if True.
+    Show the GUI if True.
     block : bool
-        Whether to halt program execution until the figure is closed.
+    Whether to halt program execution until the figure is closed.
 
     Returns
     -------
     gui : instance of ICAComponentLabeler
-        The graphical user interface (GUI) window.
+    The graphical user interface (GUI) window.
     """

mne_icalabel/gui/_label_components.pyi

@@ -42,15 +42,15 @@ class ICAComponentLabeler(QMainWindow):
         self._components_listWidget
         self._labels_buttonGroup
         self._mpl_widgets (dict)
-            - topomap
-            - psd
+        - topomap
+        - psd
         self._timeSeries_widget
 
         Matplotlib figures
         ------------------
         self._mpl_figures (dict)
-            - topomap
-            - psd
+        - topomap
+        - psd
         """
 
     @staticmethod

mne_icalabel/iclabel/_utils.pyi

@@ -14,17 +14,17 @@ def _mne_to_eeglab_locs(
     Parameters
     ----------
     raw : mne.io.BaseRaw
-        Instance of raw object with a `mne.montage.DigMontage` set with
-        ``n_channels`` channel positions.
+    Instance of raw object with a `mne.montage.DigMontage` set with
+    ``n_channels`` channel positions.
     picks : list of str
-        List of channel names to include.
+    List of channel names to include.
 
     Returns
     -------
     Rd : np.array of shape (1, n_channels)
-        Angle in spherical coordinates of each EEG channel.
+    Angle in spherical coordinates of each EEG channel.
     Th : np.array of shape (1, n_channels)
-        Degree in spherical coordinates of each EEG channel.
+    Degree in spherical coordinates of each EEG channel.
     """
 
 def _pol2cart(
@@ -35,9 +35,9 @@ def _pol2cart(
     Parameters
     ----------
     theta : array
-        angle
+    angle
     rho : array
-        magnitude
+    magnitude
     """
 
 def _next_power_of_2(x) -> int:
@@ -51,15 +51,15 @@ def _gdatav4(
     Parameters
     ----------
     x : array
-        x-coordinates
+    x-coordinates
     y : array
-        y-coordinates
+    y-coordinates
     v : array
-        values
+    values
     xq : array
-        x-grid
+    x-grid
     yq : array
-        y-grid
+    y-grid
 
     Returns
     -------
@@ -83,11 +83,11 @@ def _mergepoints2D(
     Parameters
     ----------
     x : array
-        x-coordinates
+    x-coordinates
     y : array
-        y-coordinates
+    y-coordinates
     v : array
-        values
+    values
 
     Returns
     -------