Skip to content

Commit

Permalink
fixed docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
CarinaFo committed Feb 28, 2024
1 parent caac9f4 commit fa9567a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions mne/epochs.py
Original file line number Diff line number Diff line change
Expand Up @@ -693,19 +693,20 @@ def __init__(
self._check_consistency()
self.set_annotations(annotations, on_missing="ignore")

@verbose
def set_bad_epochs_to_NaN(self, bad_epochs_indices: list = None, verbose=None):
def set_bad_epochs_to_NaN(self, bad_epochs_indices: list = None):
"""
define bad epochs based on indices list and set to NaN.
Works in-place.
Define bad epochs based on indices list and set to NaN.
Parameters
----------
self : instance of Epochs
bad_epochs_indices : list of arrays
List of arrays with indices of bad epochs per channel.
verbose : bool, str, int, or None
Notes
-----
This function operates in-place.
"""
if not self.preload:
raise ValueError("Data must be preloaded.")
Expand Down

0 comments on commit fa9567a

Please sign in to comment.