MRG: Deprecrate pick channels in info #10039
Conversation
mscheltienne
changed the title
|
To give some context, I wanted to see if |
|
Doc build failure doesn't seem to be related to this PR. |
larsoner
left a comment
larsoner
left a comment
There was a problem hiding this comment.
Just some minor stuff, thanks for taking care of this @mscheltienne !
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
|
Thanks for the tips, let's see if CIs are green; I wasn't quite sure on how the deprecated decorator works (especially as it doesn't throw any warning at me in the IPython console). |
| self['ch_names'] = [ch['ch_name'] for ch in self['chs']] | ||
| self['nchan'] = len(self['chs']) | ||
|
|
||
| @deprecated('use inst.pick_channels instead.') |
There was a problem hiding this comment.
This should just automagically work. If it doesn't, I'll push a commit to fix the decorator (it's possible it has some bug)
There was a problem hiding this comment.
CIs are happy, so all good I guess, but I don't get any warning issued when using a function decorated with @deprecated in python console or in Spyder's IPython console. The docstring is edited however with .. warning:: DEPRECATED:. Is this the correct behavior for this decorator?
There was a problem hiding this comment.
I cannot replicate; on your branch I get:
>>> import mne
>>> import warnings
>>> warnings.simplefilter('always', DeprecationWarning)
>>> info = mne.create_info(2, 1000., 'eeg')
>>> info.pick_channels(info['ch_names'][:1])
<decorator-gen-25>:4: DeprecationWarning: Function pick_channels is deprecated; use inst.pick_channels instead.
There was a problem hiding this comment.
Getting the warning as well on this mac laptop.. I guess the problem is with my windows computer and the venv.
|
Thanks @mscheltienne ! |
2 participants
Follow up on the discussion in #10035