Skip to content

Deprecate setting the timer interval while starting it. #26894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2023
Merged

Deprecate setting the timer interval while starting it. #26894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/next_api_changes/deprecations/26894-AL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*interval* parameter of ``TimerBase.start``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Setting the timer *interval* while starting it is deprecated. The interval can
be specified instead in the timer constructor, or by setting the
``timer.interval`` attribute.
1 change: 1 addition & 0 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,6 +1117,7 @@ def __del__(self):
"""Need to stop timer and possibly disconnect timer."""
self._timer_stop()

@_api.delete_parameter("3.9", "interval", alternative="timer.interval")
def start(self, interval=None):
"""
Start the timer object.
Expand Down