From fa9567a8a61e21e2e91f77aed865ab83a7bb8fc9 Mon Sep 17 00:00:00 2001 From: CarinaFo Date: Wed, 28 Feb 2024 15:42:53 +0100 Subject: [PATCH] fixed docstring --- mne/epochs.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/mne/epochs.py b/mne/epochs.py index 4ad44fae491..4814bc6a0d2 100644 --- a/mne/epochs.py +++ b/mne/epochs.py @@ -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.")