8000 DOC: Start to document interactive figures by tacaswell · Pull Request #4779 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

DOC: Start to document interactive figures #4779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 36 commits into from
May 21, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
cfa717a
DOC: Start to document interactive figures
tacaswell Jul 24, 2015
206f99c
DOC: improve text
tacaswell Jul 31, 2015
fa36c95
DOC: address comments
tacaswell Jan 7, 2017
8b28c01
DOC/WIP: updates to docs on how event loops work
tacaswell Jul 28, 2017
7189eed
DOC: add blocking_input docs
tacaswell Dec 28, 2017
98ae26c
WIP: Lots of text changes to interactive guide
tacaswell Dec 28, 2017
6263284
MNT: add warnings to Figure.show
tacaswell Dec 29, 2017
09deda3
DOC: re-arrange shell.rst and interactive.rst
tacaswell Jan 3, 2018
ec4230a
DOC/WIP: more edits and content
tacaswell Jul 10, 2018
d1a7a3e
WIP: more notes
tacaswell Mar 2, 2019
b49973a
DOC: merge the blocking API docs together
tacaswell Apr 28, 2020
bb8058a
DOC: remove rst files that have been merged into interactive.rst
tacaswell Apr 28, 2020
bc4ecd5
DOC: fix and sort intersphinx
tacaswell Apr 28, 2020
49f49fa
DOC: re-write pyplot.show docstring
8000 tacaswell Apr 29, 2020
295d71d
DOC: plt.pause is no longer experimental
tacaswell Apr 29, 2020
c3c5013
DOC: update pyplot documentation
tacaswell Apr 30, 2020
d9df057
DOC: Lots of editing to interactive figure documentation
tacaswell Apr 30, 2020
7b0b327
DOC: it's -> its
tacaswell Apr 30, 2020
5a426d6
DOC: spelling
tacaswell Apr 30, 2020
8ab0a65
DOC: edits from review
tacaswell May 1, 2020
d70d5ad
DOC: update skipped references
tacaswell May 1, 2020
757e040
DOC: correct many spelling / grammer / clarity issues
tacaswell May 3, 2020
b0690ff
DOC: remove badly named and superfluous heading
tacaswell May 7, 2020
cc3ac5b
DOC: address review comments
tacaswell May 7, 2020
afe9edd
DOC: edits from review
tacaswell May 7, 2020
e09cab9
DOC: more small edits
tacaswell May 7, 2020
04f2fc6
DOC: fix spyder spelling
tacaswell May 7, 2020
9d842bf
DOC: edits from review
tacaswell May 7, 2020
41e19a8
MNT: remove unused import
tacaswell May 7, 2020
eda2ed3
DOC: edits from review
tacaswell May 9, 2020
7cf68e8
DOC: remove non-existent function call
tacaswell May 9, 2020
bfa3589
DOC: edits and duplicate removal
tacaswell May 9, 2020
6edcb47
DOC: windows not widows
tacaswell May 9, 2020
9b492bd
DOC: Revert all changes to blocking_input_api.rst
tacaswell May 9, 2020
6d4747f
DOC: reduce jargon and correct grammar
tacaswell May 20, 2020
f05ea3d
DOC: grammar / wording corrections from review
tacaswell May 20, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC: edits from review
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
  • Loading branch information
tacaswell and QuLogic 8000 authored May 9, 2020
commit eda2ed3f539415eec040996474681b21443de13f
4 changes: 2 additions & 2 deletions doc/users/interactive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ tools are sufficient, but you can also use the Matplotlib event system
to build customized data exploration tools.

Matplotlib ships with :ref:`backends <what-is-a-backend>` binding to
several GUI toolkits (Qt, Tk, Wx, Gtk, OSX, js) and third party
several GUI toolkits (Qt, Tk, Wx, GTK, macOS, JavaScript) and third party
packages provide bindings to `kivy
<https://github.com/kivy-garden/garden.matplotlib>`__ and `Jupyter Lab
<https://github.com/matplotlib/ipympl>`__. For the figures to be
Expand Down Expand Up @@ -288,7 +288,7 @@ If you are running your jupyter kernel locally you can use one of the
GUI backends. The process running your kernel will show a GUI window
on your desktop adjacent to your web browser. However if you move
that notebook to a remote server the kernel will try to open the GUI
window on _that_ computer. Unless you have arranged to forward the
window on *that* computer. Unless you have arranged to forward the
xserver back to your desktop, you not be able to see or interact with
the figure (if it does not raise an exception outright).

Expand Down
8 changes: 4 additions & 4 deletions doc/users/interactive_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ Eventloop integration mechanism
CPython / readline
------------------

The python capi provides a hook, :c:var:`PyOS_InputHook`, to register a
The Python C API provides a hook, :c:var:`PyOS_InputHook`, to register a
function to be run "The function will be called when Python's
interpreter prompt is about to become idle and wait for user input
from the terminal.". This hook can be used to integrate a second
Copy link
Contributor

Choose a reason for hiding this comment

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

Why "second event loop"? What would be the first event loop?

Copy link
Member Author

Choose a reason for hiding this comment

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

The python prompt itself.

Expand All @@ -404,7 +404,7 @@ run the event loop until a key is pressed on stdin.


Matplotlib does not currently do any management of
:c:var:`PyOS_InputHook` due to the wide range of ways that matplotlib
:c:var:`PyOS_InputHook` due to the wide range of ways that Matplotlib
is used. This management is left to downstream libraries -- either
user code or the shell. Interactive figures, even with matplotlib in
'interactive mode', may not work in the vanilla python repl if an
Expand All @@ -422,9 +422,9 @@ IPython / prompt toolkit

With IPython >= 5.0 IPython has changed from using cpython's readline
based prompt to a ``prompt_toolkit`` based prompt. ``prompt_toolkit``
has the same conceptual input hook, which is feed into prompt_toolkit via the
has the same conceptual input hook, which is fed into ``prompt_toolkit`` via the
:meth:`IPython.terminal.interactiveshell.TerminalInteractiveShell.inputhook`
method. The source for the prompt_toolkit input hooks lives at
method. The source for the ``prompt_toolkit`` input hooks lives at
:mod:`IPython.terminal.pt_inputhooks`


Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/pyplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -309,11 +309,11 @@ def show(*args, **kwargs):
"""
Display all open figures.

In non-interactive mode, **block** defaults to True. All figures
In non-interactive mode, *block* defaults to True. All figures
will display and show will not return until all windows are closed.
If there are no figures, return immediately.

In interactive mode **block** defaults to False. This will ensure
In interactive mode *block* defaults to False. This will ensure
that all of the figures are shown and this function immediately returns.

Parameters
Expand Down
0