Trying to improve the docstring ofdraw_idle(). Though I'm not sure what exactly its pupose is and when it should be used. Can someone with more experience on the internals comment on this please?

timhoffm added the Documentation label

Oct 13, 2018

Copy link

Contributor

anntzer commentedOct 14, 2018

Should be something like

        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, (backends should arrange that)        the figure will only be rendered once.

where the parenthesis depends on whether you're writing the docs for backend implementers or for end users.

Improve docstring of draw_idle()

27c8ee1

Copy link

MemberAuthor

timhoffm commentedOct 14, 2018

Thanks. IMO the main audience of the docs are the end users. I've dropped the parenthesis but left my note instead. That keeps the information in but a bit separated.

Btw. can we make a suggestion to the end-user if she should calldraw() ordraw_idle()? We have both cases quite mixed in the examples.

timhoffm force-pushed thedoc-draw-idle branch from301660d to27c8ee1Compare

October 14, 2018 19:58

Copy link

Member

ImportanceOfBeingErnest commentedOct 14, 2018•
edited
Loading

If the draw event happens inside the event loop one should definitely calldraw_idle(). Actually I think my very first PR here was about exactly that (#9064). If no event loop has been started,draw_idle() potentially has no effect.
There is also#5800, which suggests there actually is a drawback from calling it with non-GUI backends.