mne-tools / mne-tools/mne-python
ENH: Add ctrl+key or alt+key as another way to move in large steps.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Problem
There is a bug that can occur in the matplotlib tkinter backend that can prevent shift+key combo events from being correctly passed. A shift+key combo is used in mne interactive plots to move in large steps, and the tkinter backend bug can break this feature.
Solution
A good enhancement would be to add the additional keybind ctrl+key or alt+key which performs the same functionality as shift+key in case a user has this bug.
Alternative
Alternatively, using the pyqt5 backend for matplotlib also fixes this bug, but this would require pyqt5 to be installed.
Additional context
This issue was discussed on gitter before posting here.
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 MNE interactive plot key-handling entry point and the tests covering shift+key movement. Compare the existing large-step behavior with the proposed ctrl+key or alt+key alternative, then verify that the fallback works with the matplotlib tkinter backend without changing the existing shift+key behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- matplotlib, python
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100