Fix kwarg handling in legacy .plot_psd() method#11778
Merged
drammock merged 5 commits intomne-tools:mainfrom Jul 11, 2023
Merged
Fix kwarg handling in legacy .plot_psd() method#11778drammock merged 5 commits intomne-tools:mainfrom
drammock merged 5 commits intomne-tools:mainfrom
Conversation
Member
Okay by me / no strong feeling either way 👍 |
Member
|
As long as the warning incite people to use the new API, sounds good to me! |
agramfort
approved these changes
Jul 5, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
closes #11772
new behavior is
raw.plot_psd()that are not recognized params of that method but happen to be params of Spectrum.plot() now raise a warning.plot_raw_psd().@larsoner @mscheltienne LMK if you think this is a good approach... normally unrecognized kwargs will raise a TypeError (and we could do that here) but my feeling was that since this is a legacy method whose kwargs are getting split up and translated to be passed into a chain of two new methods, it might be nice/smart/OK to be more forgiving.
Once we agree on an implementation I can add test/changelog