matplotlib / matplotlib/matplotlib
[MNT]: Some Timer behaviors are underspecified
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 23.2k
- Forks
- 8.5k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 66
Description
### Summary
It is unclear whether updating the `interval` or `single_shot` attributes of an already running Timer instance should actually update the timer, and I think the behavior is actually not consistent between backends. From a quick look:
- gtk, qt, wd: both interval and single_shot update the running timer
- wx, webagg: interval updates the running timer, not single_shot
- macos: neither update the running timer
### Proposed fix
Specify the expected behavior. (I'm not actually so sure we actually need to support updating these attributes on a running timer at all.)
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
Review the Timer API and compare the listed gtk, qt, wd, wx, webagg, and macos backend behaviors for changes to interval and single_shot on running timers. Decide whether those attributes should update an active timer, then specify the expected behavior and ensure the documented contract is consistent across backends.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100