Merge pull request matplotlib#8897 from vab9/patch-1

tacaswell · web-flow · commit f53be2f3c39f · 2017-08-09T23:46:38.000-04:00
DOC:  Update Usage FAQ to reflect new behavior
diff --git a/tutorials/introductory/usage.py b/tutorials/introductory/usage.py
@@ -542,24 +542,21 @@ def my_plotter(ax, data1, data2, param_dict):
 #     plt.title("interactive test")
 #     plt.xlabel("index")
 #
-# and you will see the plot being updated after each line.  This is
-# because you are in interactive mode *and* you are using pyplot
-# functions. Now try an alternative method of modifying the
-# plot.  Get a reference to the :class:`~matplotlib.axes.Axes` instance, and
-# call a method of that instance::
+# and you will see the plot being updated after each line.  Since version 1.5,
+# modifying the plot by other means *should* also automatically
+# update the display on most backends. Get a reference to the :class:`~matplotlib.axes.Axes` instance,
+# and call a method of that instance::
 #
 #     ax = plt.gca()
 #     ax.plot([3.1, 2.2])
 #
-# Nothing changed, because the Axes methods do not include an
-# automatic call to :func:`~matplotlib.pyplot.draw_if_interactive`;
-# that call is added by the pyplot functions.  If you are using
-# methods, then when you want to update the plot on the screen,
-# you need to call :func:`~matplotlib.pyplot.draw`::
+# If you are using certain backends (like `macosx`), or an older version
+# of matplotlib, you may not see the new line added to the plot immediately.
+# In this case, you need to explicitly call :func:`~matplotlib.pyplot.draw`
+# in order to update the plot::
 #
 #     plt.draw()
 #
-# Now you should see the new line added to the plot.
 #
 # Non-interactive example
 # -----------------------

Original file line number	Diff line number	Diff line change
`@@ -542,24 +542,21 @@ def my_plotter(ax, data1, data2, param_dict):`
`542`	`542`	`# plt.title("interactive test")`
`543`	`543`	`# plt.xlabel("index")`
`544`	`544`	`#`
`545`		`-# and you will see the plot being updated after each line. This is`
`546`		`-# because you are in interactive mode and you are using pyplot`
`547`		`-# functions. Now try an alternative method of modifying the`
`548`		-# plot. Get a reference to the :class:`~matplotlib.axes.Axes` instance, and
`549`		`-# call a method of that instance::`
	`545`	`+# and you will see the plot being updated after each line. Since version 1.5,`
	`546`	`+# modifying the plot by other means should also automatically`
	`547`	+# update the display on most backends. Get a reference to the :class:`~matplotlib.axes.Axes` instance,
	`548`	`+# and call a method of that instance::`
`550`	`549`	`#`
`551`	`550`	`# ax = plt.gca()`
`552`	`551`	`# ax.plot([3.1, 2.2])`
`553`	`552`	`#`
`554`		`-# Nothing changed, because the Axes methods do not include an`
`555`		-# automatic call to :func:`~matplotlib.pyplot.draw_if_interactive`;
`556`		`-# that call is added by the pyplot functions. If you are using`
`557`		`-# methods, then when you want to update the plot on the screen,`
`558`		-# you need to call :func:`~matplotlib.pyplot.draw`::
	`553`	+# If you are using certain backends (like `macosx`), or an older version
	`554`	`+# of matplotlib, you may not see the new line added to the plot immediately.`
	`555`	+# In this case, you need to explicitly call :func:`~matplotlib.pyplot.draw`
	`556`	`+# in order to update the plot::`
`559`	`557`	`#`
`560`	`558`	`# plt.draw()`
`561`	`559`	`#`
`562`		`-# Now you should see the new line added to the plot.`
`563`	`560`	`#`
`564`	`561`	`# Non-interactive example`
`565`	`562`	`# -----------------------`