Skip to content

DOC: Fix type annotation for order parameter in Epochs.plot() #13639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YadavAkhileshh wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −2
Open

DOC: Fix type annotation for order parameter in Epochs.plot() #13639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions mne/viz/epochs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -800,8 +800,12 @@ def plot_epochs(
The new equivalent is ``events=False``.
%(event_color)s
Defaults to ``None``.
order : array of str | None
Order in which to plot channel types.
order : array of int | None
Copy link
Contributor

@scott-huberty scott-huberty Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
order : array of int | None
order : array-like of int | None

Order in which to plot data. If the array is shorter than the number of
channels, only the given channels are plotted. If None (default), all
Copy link
Contributor

@scott-huberty scott-huberty Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
channels, only the given channels are plotted. If None (default), all
channels, only the given channels are plotted. If ``None`` (default), all

channels are plotted. If ``group_by`` is ``'position'`` or
``'selection'``, the ``order`` parameter is used only for selecting the
channels to be plotted.

.. versionadded:: 0.18.0
show : bool
Expand Down