@@ -2428,21 +2428,24 @@ def new_timer(self, *args, **kwargs):
2428
2428
def flush_events (self ):
2429
2429
"""Flush the GUI events for the figure.
2430
2430
2431
- GUI backends likely need to reimplement this method.
2431
+ Interactive backends need to reimplement this method.
2432
2432
"""
2433
2433
2434
2434
def start_event_loop (self , timeout = 0 ):
2435
2435
"""Start a blocking event loop.
2436
2436
2437
- Such an event loop is used by interactive functions, such as ginput and
2438
- waitforbuttonpress, to wait for events. This should not be confused
2439
- with the main GUI event loop, which is independent and always running.
2437
+ Such an event loop is used by interactive functions, such as `ginput`
2438
+ and `waitforbuttonpress`, to wait for events.
2440
2439
2441
2440
The event loop blocks until a callback function triggers
2442
- `stop_event_loop`, or *timeout* is reached. If *timeout* is negative,
2443
- never timeout.
2441
+ `stop_event_loop`, or *timeout* is reached.
2444
2442
2445
- Only GUI backends need to reimplement this method.
2443
+ If *timeout* is negative, never timeout.
2444
+
2445
+ Only interactive backends need to reimplement this method and it relies
2446
+ on `flush_events` being properly implemented.
2447
+
2448
+ Interactive backends should implement this in a more native way.
2446
2449
"""
2447
2450
if timeout <= 0 :
2448
2451
timeout = np .inf
@@ -2457,7 +2460,8 @@ def start_event_loop(self, timeout=0):
2457
2460
def stop_event_loop (self ):
2458
2461
"""Stop the current blocking event loop.
2459
2462
2460
- Only GUI backends need to reimplement this method.
2463
+ Interactive backends need to reimplement this to match
2464
+ `start_event_loop`
2461
2465
"""
2462
2466
self ._looping = False
2463
2467
0 commit comments