Skip to content

FIX, DOC: Bug in plot_evoked_joint API #13159

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

FIX, DOC: Bug in plot_evoked_joint API #13159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
90f662d
FIX, DOC: Bug in plot_evoked_joint API
scott-huberty Mar 13, 2025
2f8b923
DOC: changelog
scott-huberty Mar 19, 2025
0dd3297
FIX: rst syntax
scott-huberty Mar 19, 2025
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
1 change: 1 addition & 0 deletions doc/changes/devel/13159.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Changed ``exclude=None`` to ``exclude="bads"`` in :func:`~mne.viz.plot_evoked_joint`, because ``None`` was not a valid argument for this parameter. By `Scott Huberty`_.
7 changes: 4 additions & 3 deletions mne/viz/evoked.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1797,7 +1797,7 @@ def plot_evoked_joint(
times="peaks",
title="",
picks=None,
exclude=None,
exclude="bads",
show=True,
ts_args=None,
topomap_args=None,
Expand All @@ -1824,9 +1824,10 @@ def plot_evoked_joint(
axes are passed make sure to set ``title=None``, otherwise some of your
axes may be removed during placement of the title axis.
%(picks_all)s
exclude : None | list of str | 'bads'
exclude : list of str | 'bads'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

should we change this to something like exclude : empty list | list of str | 'bads'?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think so empty list is covered by list of str well enough I think

Channels names to exclude from being shown. If ``'bads'``, the
bad channels are excluded. Defaults to ``None``.
bad channels are excluded. If an empty list, no channels are
excluded. Defaults to ``"bads"``.
show : bool
Show figure if ``True``. Defaults to ``True``.
ts_args : None | dict
Expand Down