DOC: Start to document interactive figures by tacaswell · Pull Request #4779 · matplotlib/matplotlib

tacaswell · 2015-07-24T06:28:55Z

This is still a work in progress (as there are still empty sections)

@mdehoon @WeatherGod Thoughts?

mdehoon · 2015-07-24T09:36:51Z

Btw I think issue #4732 should be addressed first.

tacaswell · 2015-07-24T16:45:56Z

#4732 in addressed by #4738

tacaswell · 2015-08-06T19:57:50Z

@mdehoon Have you had a chance to look at the updated text?

mdboom · 2015-08-06T20:41:12Z

doc/users/interactive_guide.rst

Maybe add the reference: "For further details see: http://www.amazon.com/Interactive-Applications-using-Matplotlib-Benjamin/dp/1783988843?"

blink1073 · 2015-09-01T03:07:49Z

doc/users/interactive_guide.rst

mdboom · 2015-10-20T18:23:18Z

I'm not going to let this hold up 1.5.0 -- as it's doc only, it's low cost to just put it in 1.5.1.

QuLogic · 2016-02-18T01:12:39Z

I don't think this is required to be on 2.0.

tacaswell · 2020-05-07T21:35:22Z

@QuLogic I think I got all of your comments

QuLogic

Is this still WIP?

doc/users/interactive.rst

tacaswell · 2020-05-07T22:05:15Z

In principle this is good to go, but I am not a great writer...

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

doc/api/blocking_input_api.rst

doc/users/interactive.rst

QuLogic · 2020-05-08T03:59:25Z

doc/users/interactive.rst

+   :template: autosummary.rst
+   :nosignatures:
+
+   pyplot.show


Was there a reason for having these two separately from the above?

I was trying to group ion, ioff, isinteractive as a "family" that queries and modifies the state of interactive mode and these two as a "family" that may run the GUI event loop. I'm not sure if it works as well in practice as it does in my head.

It's a logical distinction; is it worth preceding each group with a concise statement of what makes it a family?

doc/users/interactive_guide.rst

lib/matplotlib/pyplot.py

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

QuLogic

I suppose we can leave this till Monday or whenever we tag 3.3 rc.

lib/matplotlib/pyplot.py

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

efiring

Partial review so far--I haven't looked beyond interactive.rst. Thank you for moving this forward. It doesn't have to be perfect to be merged; it's a big step in the right direction.

efiring · 2020-05-10T06:10:31Z

doc/users/interactive.rst

+   :template: autosummary.rst
+   :nosignatures:
+
+   pyplot.show


It's a logical distinction; is it worth preceding each group with a concise statement of what makes it a family?

doc/users/interactive.rst

efiring · 2020-05-10T06:20:16Z

doc/users/interactive.rst

+If you are in non-interactive mode (or created figures while in
+non-interactive mode) you may need to explicitly call `.pyplot.show`
+to bring the windows onto your screen.  If you only want to run the
+GUI event loop for a fixed amount of time you can use `.pyplot.pause`.


-> "GUI event loop and block for a fixed amount of time..." In the typical (I suspect) use case, the key desired behavior is the blocking, not the interactivity via the GUI event loop.

doc/users/interactive.rst

efiring · 2020-05-10T06:36:18Z

doc/users/interactive.rst

+integrated with your command prompt.  If you have the GUI event loop
+integrated with your prompt, then shown figures will be "live" while
+the prompt is waiting for input, if it is not integrated then your
+figures will only be "live" when the GUI event loop is running (via


This is confusing to me. Where does "interactive mode" fit into this second part of the paragraph? Maybe the missing point is that in "interactive mode" but without ipython magic, when working at the command line, the figure will be updated on the screen with each command, but it will not respond to mouse actions or keystrokes; for that, one needs the magic.

At least PyQt and tkinter have ship with hooks that integrate with the readline implementation of the "plain" Python prompt. The IPython magic is the easiest way but not the only way.

efiring · 2020-05-10T06:58:11Z

doc/users/interactive.rst

+Close Figure                       :rc:`keymap.quit`
+Constrain pan/zoom to x axis       hold **x** when panning/zooming with mouse
+Constrain pan/zoom to y axis       hold **y** when panning/zooming with mouse
+Preserve aspect ratio              hold **CONTROL** when panning/zooming with mouse


This is needed only for zooming, I think; panning never changes the aspect ratio.

right-click pan will change the view limits and respect this.

I've never heard of right-click pan before, as far as I know. Maybe I've never stumbled over it because I use the Mac trackpad rather than a mouse.

right-click zoom zooms out (by putting the current view limits to be where the box you drew was)

doc/users/interactive.rst

doc/users/interactive_guide.rst

QuLogic

A couple small typos.

doc/users/interactive.rst

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

QuLogic · 2020-05-21T03:56:56Z

I don't know if it's old, or too large, or what, but I had to try 3 times to merge that...

In bb8058a via matplotlib#4779 I accidentally deleted the (illustrated) section on what the buttons on the default toolbar do. I suspect that this was a bad rebase as I do not think I would have intentionally deleted this content. This commit: - restores the content as-was: git checkout b49973a doc/users/navigation_toolbar.rst - fixes the paths to images (the files have moved around) - copy the navigation content into interactive.rst and re-remove navigation_toolbar.rst Partially addresses matplotlib#25266.

tacaswell added the status: needs review label Jul 24, 2015

tacaswell added this to the next point release milestone Aug 6, 2015

mdboom reviewed Aug 6, 2015
View reviewed changes

tacaswell added the Documentation label Aug 14, 2015

blink1073 reviewed Sep 1, 2015
View reviewed changes

doc/users/interactive_guide.rst Outdated

Copy link
Copy Markdown

Member

blink1073 Sep 1, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(sp)

tacaswell modified the milestones: next major release (2.0), next point release (1.5.0) Oct 29, 2015

QuLogic modified the milestones: 2.1 (next point release), 2.0 (style change major release) Feb 18, 2016

tacaswell mentioned this pull request Jul 1, 2016

Update multiprocess.py #6637

Closed

tacaswell mentioned this pull request Oct 25, 2016

Interactive mode seems to be broken on MacOSX #7351

Closed

tacaswell modified the milestones: 2.0.1 (next bug fix release), 2.1 (next point release) Dec 17, 2016

NelleV changed the title ~~DOC: Start to document interactive figures~~ [WIP] DOC: Start to document interactive figures Dec 19, 2016

tacaswell mentioned this pull request Jan 7, 2017

matplotlib dynamic plotting #7759

Closed

tacaswell force-pushed the doc_interactive_doc branch from fde979f to 61a194b Compare January 7, 2017 21:32

tacaswell mentioned this pull request Mar 30, 2017

plotting with TkAgg backend becomes unresponsive after a certain qt5agg backend import command #8402

Closed

tacaswell mentioned this pull request Apr 18, 2017

plot window hangs and/or is generally unresponsive #8505

Closed

QuLogic modified the milestones: 2.0.1 (next bug fix release), 2.0.2 (next bug fix release) May 3, 2017

QuLogic reviewed May 7, 2020

View reviewed changes

tacaswell changed the title ~~[WIP] DOC: Start to document interactive figures~~ DOC: Start to document interactive figures May 7, 2020

tacaswell and others added 5 commits May 7, 2020 18:08

DOC: edits from review

afe9edd

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

DOC: more small edits

e09cab9

DOC: fix spyder spelling

04f2fc6

DOC: edits from review

9d842bf

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

MNT: remove unused import

41e19a8

QuLogic approved these changes May 8, 2020

View reviewed changes

tacaswell and others added 3 commits May 8, 2020 20:09

DOC: edits from review

eda2ed3

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

DOC: remove non-existent function call

7cf68e8

DOC: edits and duplicate removal

bfa3589

QuLogic reviewed May 9, 2020

View reviewed changes

lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved

lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved

lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved

tacaswell and others added 2 commits May 9, 2020 18:18

DOC: windows not widows

6edcb47

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

DOC: Revert all changes to blocking_input_api.rst

9b492bd

efiring reviewed May 10, 2020

View reviewed changes

tacaswell mentioned this pull request May 17, 2020

DOC: add a blitting tutorial #10187

Merged

brunobeltran reviewed May 18, 2020

View reviewed changes

doc/users/interactive_guide.rst Outdated Show resolved Hide resolved

DOC: reduce jargon and correct grammar

6d4747f

QuLogic reviewed May 20, 2020

View reviewed changes

DOC: grammar / wording corrections from review

f05ea3d

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

QuLogic merged commit 46936d7 into matplotlib:master May 21, 2020

story645 mentioned this pull request May 21, 2020

Removed idiomatic constructs from interactive figures docs #17471

Merged

tacaswell deleted the doc_interactive_doc branch May 21, 2020 14:07

timhoffm mentioned this pull request Jul 14, 2020

Doc changes to plt.show #11720

Closed

6 tasks

tacaswell mentioned this pull request May 19, 2023

DOC: restore navigation documentation #25926

Merged

2 tasks

Uh oh!

Conversation

tacaswell commented Jul 24, 2015

Uh oh!

mdehoon commented Jul 24, 2015

Uh oh!

tacaswell commented Jul 24, 2015

Uh oh!

tacaswell commented Aug 6, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdboom commented Oct 20, 2015

Uh oh!

QuLogic commented Feb 18, 2016

Uh oh!

tacaswell commented May 7, 2020

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tacaswell commented May 7, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

efiring left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!