Skip to content

Commit 83d48ec

Browse files
author
Joan Massich
committed
[DOC][FIX] update missing docstring in #5841
1 parent d5f1de4 commit 83d48ec

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

mne/io/edf/edf.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1100,10 +1100,12 @@ def read_raw_edf(input_fname, montage=None, eog=None, misc=None,
11001100
Names of channels or list of indices that should be designated
11011101
MISC channels. Values should correspond to the electrodes in the
11021102
edf file. Default is None.
1103-
stim_channel : 'auto' | list of str
1104-
Channels appearing in this list are set as channels of type 'stim'.
1105-
It defaults to 'auto' where channels matching 'status' or 'trigger'
1106-
are set as 'stim'. The matching is not case sensitive.
1103+
stim_channel : 'auto' | str | list of str | int | list of int
1104+
It defaults to 'auto' where channels named 'status' or 'trigger'
1105+
are set as 'stim'. When str (or list of str) channels matching this
1106+
string are set as 'sitm'. The matching is not case sensitive, same for
1107+
the default behavior. When int (or list of ints) the channel
1108+
corresponding to this position is set as channels of type 'stim'.
11071109
11081110
.. warning:: 0.18 does not allow for stim channel synthesis from
11091111
the TAL channels called 'EDF Annotations' or

0 commit comments

Comments
 (0)