MRG: selection.read_selection() ➡️ channels.read_vectorview_selection() #8870

hoechenberger · 2021-02-13T16:25:29Z

@larsoner There is a bug in deprecated_alias:

/Users/hoechenberger/Development/mne-python/mne/utils/docs.py:2551: DeprecationWarning: Function 
read_neuromag_selection is deprecated; read_selection has been deprecated in favor of
read_neuromag_selection and will be removed in 0.24

In the sentence before the semicolon, it refers to the new function name, not to the deprecated one.

Additional information

I moved the API section of the changelog up above the bugs section, and added a new section
"Deprecations" directly below, now placing "Bugs" last. I think this is better for most users as the
number of API changes and deprecations is typically small, compared to the endless number
of bugs we fix. If API changes & deprecations are listed after the bugs, I think they're easy to miss.
Of course, totally up for discussion.

agramfort · 2021-02-13T21:14:43Z

maybe vectorview is a better name than neuromag ?

hoechenberger · 2021-02-13T21:59:39Z

Sure, why not!

hoechenberger · 2021-02-14T10:11:19Z

Closed & reopened to restart CI.

larsoner · 2021-02-16T19:01:40Z

doc/changes/latest.inc


 - Static type checkers like Pylance (comes with VS Code) now display the parameters of many more functions correctly, largely improving overall usability for VS Code users (:gh:`8862` by `Richard Höchenberger`_)

+- Add ``match_alias`` parameter to :meth:`mne.io.Raw.set_montage` and related functions to match unrecognized channel location names to known aliases (:gh`8799` **by new contributor** |Zhi Zhang|_)


New contributor line needs to be at the top of the section

larsoner · 2021-02-16T19:03:40Z

doc/changes/latest.inc

+~~~~~~~~~~~
+- None
+
+Deprecations


Did we decide to make a new section called Deprecations? Usually this is what API changes is for I think -- ENH/BUG/API has been the standard section naming and order for all our releases. Let's not reorganize/rename/reorder in this PR, but if this important to you we can discuss and then redo all of the lists in a separate PR.

Yes we only have API section

Did we decide to make a new section called Deprecations?

Nope, this is a new proposal here :)

Let's not reorganize/rename/reorder in this PR, but if this important to you we can discuss and then redo all of the lists in a separate PR.

Will revert this here and make a new proposal in a separate PR

mne/tests/test_read_neuromag_selection.py

mne/channels/channels.py

Fixes mne-tools#8865

hoechenberger · 2021-02-17T13:32:56Z

I believe all comments have been addressed.

larsoner · 2021-02-17T15:06:08Z

mne/channels/channels.py

+    The ``name`` parameter can be a string or a list of string. The returned
+    selection will be the combination of all selections in the file where
+    (at least) one element in name is a substring of the selection name in
+    the file. For example, ``name=['temporal', 'Right-frontal']`` will produce
+    a combination of ``'Left-temporal'``, ``'Right-temporal'``, and
+    ``'Right-frontal'``.


This belongs with the parameter description or in Notes

mne/channels/channels.py

Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

larsoner · 2021-02-17T18:03:25Z

doc/changes/latest.inc

+API changes
+~~~~~~~~~~~
+- ``mne.read_selection`` has been deprecated in favor of `mne.read_vectorview_selection`. ``mne.read_selection`` will be removed in MNE-Python 0.24 (:gh:`8870` by `Richard Höchenberger`_)
+


Still not quire right, see previous comment:

ENH/BUG/API has been the standard section naming and order for all our releases. Let's not reorganize/rename/reorder in this PR

Oh wait I think it's okay, I must have been looking at an old commit!

larsoner · 2021-02-17T18:10:14Z

doc/changes/latest.inc

+API changes
+~~~~~~~~~~~
+- ``mne.read_selection`` has been deprecated in favor of `mne.read_vectorview_selection`. ``mne.read_selection`` will be removed in MNE-Python 0.24 (:gh:`8870` by `Richard Höchenberger`_)
+


Actually no it's still in the wrong spot

OUCH! Arrgh, sorry about that, will fix.

Should be good now.

larsoner · 2021-02-18T15:28:46Z

thanks @hoechenberger !

hoechenberger force-pushed the hoechenberger/issue8865 branch 2 times, most recently from 7cf259a to c4aadb2 Compare February 13, 2021 19:10

hoechenberger changed the title ~~Move read_selection() to channels.read_neuromag_selection()~~ MRG: Move read_selection() to channels.read_neuromag_selection() Feb 13, 2021

hoechenberger closed this Feb 14, 2021

hoechenberger reopened this Feb 14, 2021

hoechenberger force-pushed the hoechenberger/issue8865 branch from d674d63 to 8c878a9 Compare February 14, 2021 10:13

hoechenberger changed the title ~~MRG: Move read_selection() to channels.read_neuromag_selection()~~ MRG: selection.read_selection() ➡️ channels.read_vectorview_selection() Feb 14, 2021

hoechenberger requested review from agramfort and larsoner February 16, 2021 08:14

larsoner reviewed Feb 16, 2021

View reviewed changes

hoechenberger added 4 commits February 16, 2021 21:04

Move read_selection() to channels.read_neuromag_selection()

dad6bb5

Fixes mne-tools#8865

Fix Sphinx warning

6d3f02a

read_neuromag_selection -> read_vectorview_selection

ee5638a

Use pytest context manager

c8f6c00

hoechenberger force-pushed the hoechenberger/issue8865 branch from d361252 to c8f6c00 Compare February 16, 2021 20:04

hoechenberger added 4 commits February 16, 2021 21:20

Add API reference

a1f049c

Fix changelog

945976f

Update docstring

f470d86

Merge branch 'main' into hoechenberger/issue8865

7d6d0e8

larsoner reviewed Feb 17, 2021

View reviewed changes

mne/channels/channels.py Outdated Show resolved Hide resolved

agramfort approved these changes Feb 17, 2021

View reviewed changes

hoechenberger and others added 2 commits February 17, 2021 18:10

Update mne/channels/channels.py

bd6571a

Co-authored-by: Eric Larson <larson.eric.d@gmail.com>

Docstring, import

edd62d9

larsoner reviewed Feb 17, 2021

View reviewed changes

fix changelog [skip azp][skip github]

8e0a8c8

larsoner merged commit 53f1b85 into mne-tools:main Feb 18, 2021

hoechenberger deleted the hoechenberger/issue8865 branch February 18, 2021 16:11

larsoner mentioned this pull request Mar 22, 2021

MRG, ENH: Improve Epochs._name and Evoked.comment #9027

Merged

larsoner mentioned this pull request Apr 12, 2021

MRG: Return empty list of SSP projectors if no ECG, EOG events were found #9277

Merged


		- Static type checkers like Pylance (comes with VS Code) now display the parameters of many more functions correctly, largely improving overall usability for VS Code users (:gh:`8862` by `Richard Höchenberger`_)

		- Add ``match_alias`` parameter to :meth:`mne.io.Raw.set_montage` and related functions to match unrecognized channel location names to known aliases (:gh`8799` by new contributor \|Zhi Zhang\|_)

Uh oh!

MRG: selection.read_selection() ➡️ channels.read_vectorview_selection() #8870

MRG: selection.read_selection() ➡️ channels.read_vectorview_selection() #8870

Uh oh!

Conversation

hoechenberger commented Feb 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Additional information

Uh oh!

agramfort commented Feb 13, 2021

Uh oh!

hoechenberger commented Feb 13, 2021

Uh oh!

hoechenberger commented Feb 14, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

larsoner Feb 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hoechenberger commented Feb 17, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

larsoner commented Feb 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hoechenberger commented Feb 13, 2021 •

edited

Loading

larsoner Feb 16, 2021 •

edited

Loading