-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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.
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
RFC: get_channel_types polysemy #7487
Comments
That was for @cbrnr in #4842 so perhaps he should comment. But I agree that |
+1 to rename to get_all_channel_type_constants
assuming @CBNR is fine with that
|
I'm fine with renaming the function, but I'd prefer a slightly shorter name if possible. Also, I haven't checked the return values of |
this is now what the PR from Dan does. Except using a short function name
… |
Not possible, they do completely different things, which is why I proposed to rename one of them. What I have done is deduplicate the instance methods and the private function, which were doing (roughly) the same thing. |
I've stumbled on a not-so-nice aspect of the API when working on #7486:
mne.io.pick.get_channel_types
(source) takes no input, gets all known channel types as dict keys (values are FIFF constants forkind
andcoil_type
).mne.io.pick._get_channel_types
(source) takes anInfo
, picks, booleanunique
, and boolean whether to restrict to data channels only. Returns a list or set depending onunique
.<Raw/Epochs/Evoked>.get_channel_types
(source) method (via theContainsMixin
). Returns list of channel types.Number 1 is called once in a test, and nowhere else in the codebase. I'd like to propose renaming it from
get_channel_types
toget_all_channel_types
,show_all_channel_types
, orget_channel_types_dict
. I prefer the first option. This is a public function so it would be an API change w/ deprecation cycle. If acceptable, I could roll it into #7486 or do it in a separate PR.The text was updated successfully, but these errors were encountered: