mne-tools / mne-tools/mne-python
Add note why axial gradiometers are sometimes listed as MAG
Open
Nobody has claimed this yet.
DOC
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Sometimes axial gradiometers are listed as MAG in the console, for example for the info object. A brief note on why that is might help to avoid confusion, as briefly discussed during the office hour on 2021-07-23.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the console or info-object code that displays axial gradiometers as MAG, then read the surrounding channel-type documentation and wording. Add a brief explanation of why this naming occurs and verify that the relevant console output or documentation renders the note clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100