Merge pull request #19829 from meeseeksmachine/auto-backport-of-pr-19822-on-v3.4.x

QuLogic · web-flow · commit ebc9277752d1 · 2021-03-30T17:46:44.000-04:00
Backport PR #19822 on branch v3.4.x (Clarify default backend selection doc.)
diff --git a/doc/sphinxext/custom_roles.py b/doc/sphinxext/custom_roles.py
@@ -16,7 +16,9 @@ def rcparam_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
 
     ref = nodes.reference(rawtext, rendered, refuri=refuri)
     node_list = [nodes.literal('', '', ref)]
-    if text in rcParamsDefault:
+    # The default backend would be printed as "agg", but that's not correct (as
+    # the default is actually determined by fallback).
+    if text in rcParamsDefault and text != "backend":
         node_list.extend([
             nodes.Text(' (default: '),
             nodes.literal('', repr(rcParamsDefault[text])),
diff --git a/tutorials/introductory/usage.py b/tutorials/introductory/usage.py
@@ -304,7 +304,9 @@ def my_plotter(ax, data1, data2, param_dict):
 # backend based on what is available on your system and on whether a GUI event
 # loop is already running. On Linux, if the environment variable
 # :envvar:`DISPLAY` is unset, the "event loop" is identified as "headless",
-# which causes a fallback to a noninteractive backend (agg).
+# which causes a fallback to a noninteractive backend (agg); in all other
+# cases, an interactive backend is preferred (usually, at least tkagg will be
+# available).
 #
 # Here is a detailed description of the configuration methods:
 #

Original file line number	Diff line number	Diff line change
`@@ -304,7 +304,9 @@ def my_plotter(ax, data1, data2, param_dict):`
`304`	`304`	`# backend based on what is available on your system and on whether a GUI event`
`305`	`305`	`# loop is already running. On Linux, if the environment variable`
`306`	`306`	# :envvar:`DISPLAY` is unset, the "event loop" is identified as "headless",
`307`		`-# which causes a fallback to a noninteractive backend (agg).`
	`307`	`+# which causes a fallback to a noninteractive backend (agg); in all other`
	`308`	`+# cases, an interactive backend is preferred (usually, at least tkagg will be`
	`309`	`+# available).`
`308`	`310`	`#`
`309`	`311`	`# Here is a detailed description of the configuration methods:`
`310`	`312`	`#`