API: Deprecate ordered=False and legacy some functions #11665
Merged
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
agramfort
approved these changes
May 1, 2023
* upstream/main: BUG: Fix bug with annotation rename (mne-tools#11666) DOC: Fix table formatting (mne-tools#11663)
Member
Author
|
Okay ran the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 #11546
Closes #11531
I think this is probably good enough to close #11531. @drammock you had slight differences / a bit more stuff in #11531 (comment) . For example, I left out the new forward instance method as I think picking channels for forward is very rare for users so the cost of having to use
pick_channels_forwardis low (same with cov), and hence not worth the code churn to replace it. I did add anordered=Noneto those functions, though, in order to minimize the risk of problems for people, which I think is the most critical thing end-user-safety-wise.I also did not
@legacythemne.pick_typesfunction for now because 1) there is no straightforward replacement that allows you to get the indices of given channel types, and 2) we would have to alias all of our internal uses to a private_pick_typesto avoid thelegacyprint (and there are a lot of them). I did@legacythe instance methodinst.pick_types, though, which seems reasonable. Same goes formne.pick_channelsandinst.pick_channels.If/when this is reviewed and approved and I've fixed all the tests (I'm sure some will have broken!) I'll push a
[circle full]before merge so we can find out now about any broken examples/tutorials rather than this evening.