mne-tools / mne-tools/mne-python
filtering tutorial needs attention
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
Proposed documentation enhancement
In the "background on filtering" tutorial, the "Power line noise" section used to show all 3 sensor types, now it only shows mag because at some point we added .pick(['mag', 'stim']) at the beginning of the tutorial. This makes both the prose and the code not really make sense, e.g., the code loops over fig.axes but there is only one axes shown.
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
Locate the "background on filtering" tutorial and read its "Power line noise" section, including the initial .pick(['mag', 'stim']) call. Align the section's prose and code with the intended display of all three sensor types, including the loop over fig.axes.
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
- 45/100