Skip to content

MRG, DOC: Fix plot_evoked_joint exclude parameter default inconsistency #13391

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

Merged
merged 3 commits into from
Aug 22, 2025
Merged

MRG, DOC: Fix plot_evoked_joint exclude parameter default inconsistency #13391

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
50b03f1
DOC: Fix plot_evoked_joint exclude parameter default inconsistency
tharu-jwd Aug 22, 2025
45ff702
DOC: Add changelog entry for issue #13157
tharu-jwd Aug 22, 2025
fb27b74
Address reviewer feedback
tharu-jwd Aug 22, 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/dev/13391.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix :func:`~mne.viz.plot_evoked_joint` docstring to correctly document ``exclude`` parameter default as ``'bads'`` instead of ``None``, by :newcontrib:`Tharupahan Jayawardana`.
1 change: 1 addition & 0 deletions doc/changes/names.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,7 @@
.. _T. Wang: https://github.com/twang5
.. _Tal Linzen: https://tallinzen.net/
.. _Teon Brooks: https://github.com/teonbrooks
.. _Tharupahan Jayawardana: https://github.com/tharu-jwd
.. _Thomas Binns: https://github.com/tsbinns
.. _Thomas Hartmann: https://github.com/thht
.. _Thomas Radman: https://github.com/tradman
Expand Down
6 changes: 3 additions & 3 deletions mne/viz/evoked.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1799,7 +1799,7 @@ def plot_evoked_joint(
times="peaks",
title="",
picks=None,
exclude=None,
exclude="bads",
show=True,
ts_args=None,
topomap_args=None,
Expand All @@ -1826,9 +1826,9 @@ 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'
Channels names to exclude from being shown. If ``'bads'``, the
bad channels are excluded. Defaults to ``None``.
bad channels are excluded. Defaults to ``'bads'``.
show : bool
Show figure if ``True``. Defaults to ``True``.
ts_args : None | dict
Expand Down
Loading