[Doc]: Add annotated image of the figure GUI to explain what the different buttons do #25266
Comments
|
https://matplotlib.org/2.2.5/users/navigation_toolbar.html?highlight=interactive used to exist and https://matplotlib.org/3.2.0/users/navigation_toolbar.html?highlight=interactive appears to be the last version where it exists.... It appears that I am the villain here and deleted this page it in bb8058a 😞 |
|
I'm working on a PR to just put this page back more-or-less as-was, but there may still be more work to do to fold in to the current docs more effectively |
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.
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.
|
I am going to close this as addressed by #25926. Using icon images has advantages over an annotated screen shots. It is no extra files (we have to have the icons), will stay in sync if we ever change them, and makes the documentation GUI toolkit agnostic (we put the toolbar at the top / bottom / side depending on the toolkit) |
Documentation Link
https://matplotlib.org/devdocs/users/explain/interactive.html
Problem
We currently don't have documentation that I can find which shows how to interact with the figure GUI. The buttons have tooltips, but if a user is not familiar with that mode of getting information then they might be at a loss of what to do.
Suggested improvement
It would be nice to include at least an annotated image of the GUI calling out what the different buttons do. We can also use this opportunity to document the hover coordinates. Note that we should cover both 2D and 3D plots, as the rotate/pan/zoom behavior is slightly different between them.
It would be even better if we had a short video / animated gif showing someone interacting with the plot using the GUI buttons.
The text was updated successfully, but these errors were encountered: