From ffdac14db914c7c810e93cf256c020e6e55b487f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Richard=20H=C3=B6chenberger?= Date: Wed, 1 Dec 2021 11:09:56 +0100 Subject: [PATCH] Improve concatenate_epochs() docstring (#10045) (#10064) Fixes #10043 --- mne/epochs.py | 9 ++++++--- mne/io/base.py | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/mne/epochs.py b/mne/epochs.py index 89379e86650..f36f0f37780 100644 --- a/mne/epochs.py +++ b/mne/epochs.py @@ -3490,12 +3490,15 @@ def _finish_concat(info, data, events, event_id, tmin, tmax, metadata, @verbose def concatenate_epochs(epochs_list, add_offset=True, *, on_mismatch='raise', verbose=None): - """Concatenate a list of epochs into one epochs object. + """Concatenate a list of `~mne.Epochs` into one `~mne.Epochs` object. + + .. note:: Unlike `~mne.concatenate_raws`, this function does **not** + modify any of the input data. Parameters ---------- epochs_list : list - List of Epochs instances to concatenate (in order). + List of `~mne.Epochs` instances to concatenate (in that order). add_offset : bool If True, a fixed offset is added to the event times from different Epochs sets, such that they are easy to distinguish after the @@ -3509,7 +3512,7 @@ def concatenate_epochs(epochs_list, add_offset=True, *, on_mismatch='raise', Returns ------- epochs : instance of Epochs - The result of the concatenation (first Epochs instance passed in). + The result of the concatenation. Notes ----- diff --git a/mne/io/base.py b/mne/io/base.py index ca8a03d38c5..d151bd5f456 100644 --- a/mne/io/base.py +++ b/mne/io/base.py @@ -2490,7 +2490,7 @@ def _check_raw_compatibility(raw): @verbose def concatenate_raws(raws, preload=None, events_list=None, *, on_mismatch='raise', verbose=None): - """Concatenate raw instances as if they were continuous. + """Concatenate `~mne.io.Raw` instances as if they were continuous. .. note:: ``raws[0]`` is modified in-place to achieve the concatenation. Boundaries of the raw files are annotated bad. If you wish to use