Skip to content

Commit

Permalink
Improve concatenate_epochs() docstring (#10045) (#10064)
Browse files Browse the repository at this point in the history
Fixes #10043
  • Loading branch information
hoechenberger authored Dec 1, 2021
1 parent 73f63b3 commit ffdac14
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions mne/epochs.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
-----
Expand Down
2 changes: 1 addition & 1 deletion mne/io/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ffdac14

Please sign in to comment.