MRG, DOC: Fix plot_evoked_joint exclude parameter default inconsistency #13391
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docstring for plot_evoked_joint stated that the exclude parameter defaults to None, but the actual default was inconsistent with the evoked.plot_joint method which uses exclude="bads" as default. This commit fixes the inconsistency by: - Changing plot_evoked_joint default from exclude=None to exclude="bads" - Updating the docstring to reflect the new default Fixes mne-tools#13157
tharu-jwd
requested review from
agramfort,
dengemann,
drammock and
larsoner
as code owners
|
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴 |
drammock
requested changes
Aug 22, 2025
mne/viz/evoked.py
Outdated
| 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' |
There was a problem hiding this comment.
the code in #13157 shows that None isn't even valid input, so we should remove it here too:
Suggested change
| exclude : None | list of str | 'bads' | |
| exclude : list of str | 'bads' |
drammock
reviewed
Aug 22, 2025
There was a problem hiding this comment.
the filename of this file needs the PR number, not the issue number that it addresses. So change to 13391.bugfix.rst
There was a problem hiding this comment.
Done. Please Check.
- Remove 'None' from exclude parameter type in docstring - Rename changelog file to use PR number (13391.bugfix.rst)
drammock
approved these changes
Aug 22, 2025
|
🎉 Congrats on merging your first pull request! 🥳 Looking forward to seeing more from you in the future! 💪 |
zEdS15B3GCwq
pushed a commit
to zEdS15B3GCwq/mne-python
that referenced
this pull request
Aug 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes inconsistency between the plot_evoked_joint function signature and its docstring regarding the exclude parameter default value.
Problem
Solution
Testing
Fixes #13157