Commit0ca0c40

authored

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

Improve docstring of draw_idle()

2 parentse231439 +27c8ee1 commit0ca0c40Copy full SHA for 0ca0c40

File tree

+10

-1

lines changed

+10

-1

lines changed

Lines changed: 10 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1892,7 +1892,16 @@ def draw(self, args, *kwargs):`
`1892`	`1892`
`1893`	`1893`	`defdraw_idle(self,args,*kwargs):`
`1894`	`1894`	`"""`
`1895`		- :meth:`draw` only if idle; defaults to draw but backends can override
	`1895`	`+ Request a widget redraw once control returns to the GUI event loop.`
	`1896`	`+`
	`1897`	+ Even if multiple calls to `draw_idle` occur before control returns
	`1898`	`+ to the GUI event loop, the figure will only be rendered once.`
	`1899`	`+`
	`1900`	`+ Note`
	`1901`	`+ ----`
	`1902`	`+ Backends may choose to override the method and implement their own`
	`1903`	`+ strategy to prevent multiple renderings.`
	`1904`	`+`
`1896`	`1905`	`"""`
`1897`	`1906`	`ifnotself._is_idle_drawing:`
`1898`	`1907`	`withself._idle_draw_cntx():`

Comments

(0)