Merge pull request matplotlib#12521 from timhoffm/doc-draw-idle

NelleV · web-flow · commit 0ca0c40dd746 · 2018-10-20T10:18:59.000-07:00
Improve docstring of draw_idle()
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1892,7 +1892,16 @@ def draw(self, *args, **kwargs):
 
     def draw_idle(self, *args, **kwargs):
         """
-        :meth:`draw` only if idle; defaults to draw but backends can override
+        Request a widget redraw once control returns to the GUI event loop.
+
+        Even if multiple calls to `draw_idle` occur before control returns
+        to the GUI event loop, the figure will only be rendered once.
+
+        Note
+        ----
+        Backends may choose to override the method and implement their own
+        strategy to prevent multiple renderings.
+
         """
         if not self._is_idle_drawing:
             with self._idle_draw_cntx():
