Skip to content

Commit d44d462

Browse files
YadavAkhileshhdrammockscott-huberty
authored
DOC: Fix type annotation for order parameter in Epochs.plot() (#13639)
Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Scott Huberty <52462026+scott-huberty@users.noreply.github.com>
1 parent dbee679 commit d44d462

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

mne/viz/epochs.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -800,8 +800,12 @@ def plot_epochs(
800800
The new equivalent is ``events=False``.
801801
%(event_color)s
802802
Defaults to ``None``.
803-
order : array of str | None
804-
Order in which to plot channel types.
803+
order : array-like of int | None
804+
Order in which to plot data. If the array is shorter than the number of
805+
channels, only the given channels are plotted. If ``None`` (default), all
806+
channels are plotted. If ``group_by`` is ``'position'`` or
807+
``'selection'``, the ``order`` parameter is used only for selecting the
808+
channels to be plotted.
805809
806810
.. versionadded:: 0.18.0
807811
show : bool

0 commit comments

Comments
 (0)