Skip to content

Commit 78904b6

Browse files
committed
Deprecate setting the timer interval while starting it.
This feature is unused internally and has simple replacements; removing it will make it easier for subclasses to directly override Timer.start rather than having Timer.start handle the interval and then deferring to a private _timer_start.
1 parent 6ba7d5f commit 78904b6

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*interval* parameter of ``TimerBase.start``
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
4+
Setting the timer *interval* while starting it is deprecated. The interval can
5+
be specified instead in the timer constructor, or by setting the
6+
``timer.interval`` attribute.

lib/matplotlib/backend_bases.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,6 +1117,7 @@ def __del__(self):
11171117
"""Need to stop timer and possibly disconnect timer."""
11181118
self._timer_stop()
11191119

1120+
@_api.delete_parameter("3.9", "interval", alternative="timer.interval")
11201121
def start(self, interval=None):
11211122
"""
11221123
Start the timer object.

0 commit comments

Comments
 (0)