Movatterモバイル変換

dstansby approved these changes

Copy link

Member

dstansby left a comment

Choose a reason for hiding this comment

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

One minor suggestion, but these all look like good improvements

doc/users/interactive.rst OutdatedShow resolvedHide resolved

tacaswell previously requested changes

doc/users/interactive.rst

Copy link

Member

tacaswell left a comment

Choose a reason for hiding this comment

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

I agree with most of the wording changes, but some of the changes make the text less accurate.

doc/users/interactive.rstShow resolvedHide resolved

doc/users/interactive.rst Outdated

		- pyplot.show runs the GUI event loop and does not return until all of
		the plot windows are closed
		- newly created figures and changes to figures are not displayed until
		`.pyplot.show` is called again or `.pyplot.pause` exits

Copy link

Member

Choose a reason for hiding this comment

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

The updates will only happen whileshow orpause are blocking and well cease after they return. You can also get an update by callingfig.canvas.flush_events or by manually running the event loop.

Additionally, when not in interactive mode the stale hook is turned off so mutating the figure does not triggerdraw_idle.

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

I'm so unclear about what you're getting at here/how these suggestions translate into user facing docs.

doc/users/interactive.rst Outdated

		- whether `.pyplot.show` returns immediately or after all of the
		figures have been closed when given no arguments

		- when `.pyplot.show` exits: immediately, or after all of the figures have been closed if given no arguments

Copy link

Member

Choose a reason for hiding this comment

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

I think that "returns" is the correct language here. Processes exit, functions return.

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

I hate both and think neither is super clear, especially here where it's not super clear thatpyplot.show is being talked about in the context of it being a function.

Copy link

Contributor

Choose a reason for hiding this comment

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

"exits" is definitely incorrect for a function. Perhapspyplot.show() (with parentheses) would make things clearer?

doc/users/interactive.rst Outdated

		loop in some other way.
		at the prompt, regardless of pyplot's "interactive mode".

		The figures will also be "live" if you use ``pyplot.show(block=True)``,

Copy link

Member

Choose a reason for hiding this comment

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

Suggested change

	Thefigures will also be "live" if you use ``pyplot.show(block=True)``,
	It any case thefigures will be "live" if you use ``pyplot.show(block=True)``,

Copy link

Member

Choose a reason for hiding this comment

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

In any case,

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

in any case is an ambigious reference 'cause it's not clear what the cases are ...

doc/users/interactive.rst Outdated


		`.pyplot.figure`
		*`.pyplot.figure`

Copy link

Member

Choose a reason for hiding this comment

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

I would prefer to leave these as definition lists rather than bullet points.

doc/users/interactive.rst Outdated

		<https://github.com/matplotlib/ipympl>`__. For the figures to be
		"live" the GUI event loop will need to be integrated with your prompt. The
		simplest way is to use IPython (see :ref:`below <ipython-pylab>`).
		<https://github.com/matplotlib/ipympl>`__. For the figures to be interactive,

Copy link

Member

Choose a reason for hiding this comment

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

I use "live" here to try and disambiguate it from the several other meanings of the word "interactive".

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

"live" needs to be defined on first usage - I try to do it a little later but I can pull it up here.

		@@ -67,54 +68,46 @@ loop is properly integrated with the command line (see
		.. highlight:: ipython

		::

		user@machine:~ $ ipython

Copy link

Member

Choose a reason for hiding this comment

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

I think it is helpful to identify that we are in an IPython session, we should not assume that our readers well recognize the prompt as IPython from the style.

Copy link

MemberAuthor

Choose a reason for hiding this comment

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

We say that it's IPython in the narrative, but I'm fine putting this line back in. I just don't want them getting tripped up on all the details of your particular Ipython install

doc/users/interactive.rst OutdatedShow resolvedHide resolved

doc/users/interactive.rst Outdated


		.. sourcecode:: ipython

		%matplotlib notebook

		which uses the `.backend_nbagg` backend which ships with Matplotlib.
		However nbagg does not work in Jupyter Lab.
		which uses the `.backend_nbagg` backend which is installed by Matplotlib;

Copy link

Member

Choose a reason for hiding this comment

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

Suggested change

	which uses the `.backend_nbagg` backend whichis installed by Matplotlib;
	which uses the `.backend_nbagg` backend whichpart of Matplotlib;

"is installed by" implies it is an external package that we depend on which it is a first-party backend.

Copy link

Member

Choose a reason for hiding this comment

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

which part of -> from

tacaswell added this to thev3.3.0 milestone

QuLogic reviewed

doc/users/interactive.rst Outdated

		appropriate. Matplotlib keeps a reference to all of the open figures
		appropriate.

		Matplotlib keeps a reference to all of the open figures
		created this way so they will not be garbage collected. You can close

Copy link

Member

Choose a reason for hiding this comment

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

Looking at this again, "this way" previously had (when this was one paragraph) some tie in to the 'Current Figure'/'Current Axes' textually, but it doesn't actually in code. So I think this line needs a clarification of what 'this way' is, or this paragraph needs to go before the paragraph on 'current'-ness.

doc/users/interactive.rst Outdated

		- pyplot.show will returnimmediatelyby default
		- newly created figures will bedisplayed immediately
		- figures will automatically redrawwhen elements are changed
		-`pyplot.show` displays the figures andimmediatelyreturns to the prompt

Copy link

Member

QuLogicMay 21, 2020

Choose a reason for hiding this comment

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

That assumes you're in a prompt...

Though in a script, ifplt.ion() is called, thenplt.show() immediately returns, and your script exits because nothing is running, so I guess you do end up at a prompt eventually (just not Python's).

Copy link

MemberAuthor

story645May 21, 2020

Choose a reason for hiding this comment

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

Yeah, this is my frustration w/ the plt.show() docs - they kind of assume a prompt too and it's really unclear.

Copy link

Member

QuLogicMay 27, 2020

Choose a reason for hiding this comment

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

Not really? It just saysshow won't return, and nothing about prompts.

Copy link

MemberAuthor

story645May 27, 2020

Choose a reason for hiding this comment

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

First line of the show docs:

When running in ipython with its pylab mode, display all figures and return to the ipython prompt

And the rest of the docs use the language of blocking but don't saw what's being blocked.

Copy link

Member

QuLogicMay 27, 2020

Choose a reason for hiding this comment

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

That is no longer the first line ofshow() docs.

Copy link

MemberAuthor

story645May 27, 2020

Choose a reason for hiding this comment

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

🤦

doc/users/interactive.rst Outdated

		loop in some other way.
		at the prompt, regardless of pyplot's "interactive mode".

		The figures will also be "live" if you use ``pyplot.show(block=True)``,

Copy link

Member

QuLogicMay 21, 2020

Choose a reason for hiding this comment

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

In any case,

doc/users/interactive.rst Outdated


		.. sourcecode:: ipython

		%matplotlib notebook

		which uses the `.backend_nbagg` backend which ships with Matplotlib.
		However nbagg does not work in Jupyter Lab.
		which uses the `.backend_nbagg` backend which is installed by Matplotlib;

Copy link

Member

QuLogicMay 21, 2020

Choose a reason for hiding this comment

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

which part of -> from

doc/users/interactive.rstShow resolvedHide resolved

doc/users/interactive.rst OutdatedShow resolvedHide resolved

tacaswell added the Release criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label

May 27, 2020

story645 force-pushed theinteractivity branch fromeeeafe9 toe7a4fc3Compare

May 28, 2020 02:06

story645 added3 commits

May 28, 2020 01:49

Update documenting_mpl.rst

9ada3fe

Update documenting_mpl.rst

28c3b4f

Merge branch 'winbuild' of github.com:story645/matplotlib

05241d1

QuLogic approved these changes

May 30, 2020

doc/users/interactive.rst OutdatedShow resolvedHide resolved

QuLogic requested a review fromtacaswell

May 30, 2020 08:17

tacaswell reviewed

doc/users/interactive.rst OutdatedShow resolvedHide resolved

tacaswell reviewed

doc/users/interactive.rst Outdated


		::

		In [5]: ln.set_color('orange')

		it will be reflected immediately. If you wish to disable this behavior
		use
		If you wish to disable interactive modification of the plot:

Copy link

Member

tacaswellJun 8, 2020

Choose a reason for hiding this comment

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

It is the automatic re-draw that is disabled, if you have a prompt you can always interactively modify it (even with out the event loop integration), the user then has to intentionally trigger re-draws or spin the event loop.

Copy link

MemberAuthor

story645Jun 9, 2020

Choose a reason for hiding this comment

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

I'm using interactive modification == automatic redraw, but will clarify that

tacaswell reviewed

doc/users/interactive.rst OutdatedShow resolvedHide resolved

tacaswell reviewed

doc/users/interactive.rst OutdatedShow resolvedHide resolved

Copy link

Member

tacaswell commentedJun 9, 2020

Getting this sorted should not block tagging the RC.

tacaswell dismissed theirstale review

June 9, 2020 17:50

outdated

Copy link

MemberAuthor

story645 commentedJun 12, 2020

folks are welcome to squash merge this

story645 added2 commits

June 15, 2020 15:52

Merge branch 'master' of github.com:matplotlib/matplotlib

1f39173

cleaned up idioms, restructured the code example, stripped down sme l…

bd5d63a

…angauge

story645 force-pushed theinteractivity branch from540c643 to43032c6Compare

June 15, 2020 21:45

tacaswell approved these changes

Jun 15, 2020

Copy link

Member

tacaswell left a comment

Choose a reason for hiding this comment

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

Anyone can merge on green.

QuLogic reviewed

Jun 16, 2020