Improve consistency of sensor types in code and documentation#12509
Merged
larsoner merged 29 commits intomne-tools:mainfrom Mar 29, 2024
Merged
Improve consistency of sensor types in code and documentation#12509larsoner merged 29 commits intomne-tools:mainfrom
larsoner merged 29 commits intomne-tools:mainfrom
Conversation
…sary. ADD draft code in MNESubstitution to automaticaly update non-data types
for more information, see https://pre-commit.ci
- ADD missing types from 'get_channel_type_constants()' to 'get_data_channels()' docstring. - Replaced eyetrack_pos, eyetrack_pupil by eyegaze and pupil respectively to eb coherent with 'get_channel_type_constants()'. - Change the list to be in alphabetical order - Add a reference link to sensor types in glossary In the same way, add missing types and reference link in 'raw overview' tutorial.
…yed corresponds only to the main category (_first_rule)
for more information, see https://pre-commit.ci
…libou_data_type
…ta_type # Conflicts: # doc/sphinxext/mne_substitutions.py
FIX "non-data channels" part of mne_substitutions.py
for more information, see https://pre-commit.ci
…ta_type # Conflicts: # mne/defaults.py
…and scalings dict from defaults.py FIX docstring bullet list of create_info()
ADD an indentation in the create_info() bullet list in docstring
for more information, see https://pre-commit.ci
Contributor
Author
|
I did not manage to make a bullet point list with one line running over 2 lines without making the 2nd line bold => https://output.circle-artifacts.com/output/job/e5526822-766b-4d68-84a0-364d3d61fe7f/artifacts/0/html/generated/mne.create_info.html edit: It seems that putting 'ready for review' removes the assigned reviewers, so I'm making a manual tag just in case, @larsoner, @drammock @agramfort @dengemann |
larsoner
reviewed
Mar 28, 2024
Member
|
Also don't forget a changelog entry. I think it could go in the category |
drammock
reviewed
Mar 28, 2024
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
Member
|
Failures are unrelated and are being fixed in #12520, thanks @nabilalibou ! |
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Mar 29, 2024
* upstream/main: Improve consistency of sensor types in code and documentation (mne-tools#12509)
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Apr 15, 2024
* upstream/main: (50 commits) ENH: Improve OPM auditory dataset and example (mne-tools#12539) MAINT: Bump to latest pydata-sphinx-theme (mne-tools#12228) MRG: Simplify manual installation instructions a little by dropping explicit mention of (lib)mamba (mne-tools#12362) fix PSD weights handling when bad annotations present (mne-tools#12538) Fix phase loading (mne-tools#12537) align FFT windows to good data spans in psd_array_welch (mne-tools#12536) explicitly disallow multitaper in presence of bad annotations (mne-tools#12535) MAINT: Clean up PyVista contexts (mne-tools#12533) MAINT: Complete API change of ordered (mne-tools#12534) MAINT: Reinstall statsmodels and improve logging (mne-tools#12532) MAINT: Remove scipy.signal.morlet2 (mne-tools#12531) Update README badge links (mne-tools#12529) BUG: Fix bug with reading his_id from snirf (mne-tools#12526) [pre-commit.ci] pre-commit autoupdate (mne-tools#12524) Fix file format check in _check_eeglab_fname function (mne-tools#12523) MAINT: Reenable picard in pre testing (mne-tools#12525) MAINT: Bump to large resource class (mne-tools#12522) MAINT: Restore 2 jobs on Windows (mne-tools#12520) Add exclude_after_unique option to mne.io.read_raw_edf/read_raw_edf to search for exclude channels after making channel names unique (mne-tools#12518) Improve consistency of sensor types in code and documentation (mne-tools#12509) ...
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
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.
Aim to resolve this issue #12490 about improving the glossary for sensor types and add some referencement in some part of the documentation (docstrings, tutorial) but during the processing of this issue we found inconsistencies with @larsoner in the dictionaries containing the sensor type constants.
The objective is to adress these inconsistencies bit by bit, while keeping an eye on what breaks.
non-data channelsandsensor typesentries in theglossaryusingMNESubstitutionclass to keep it updated.sensor typesentry in set_channel_types andchannel_typedocstring and the tutorial https://mne.tools/stable/auto_tutorials/raw/10_raw_overview.html#changing-channel-name-and-typesensor typesin channel_types and https://github.com/mne-tools/mne-python/blob/main/mne/defaults.py#L192 dicts (one by one to see if anything breaks).