Merge pull request #20505 from rcomer/docs-rcparams-context-manager

jklymak · web-flow · commit 4f2f4debcd05 · 2021-06-24T10:50:51.000-07:00
Add rc_context to customizing tutorial
diff --git a/examples/lines_bars_and_markers/linestyles.py b/examples/lines_bars_and_markers/linestyles.py
@@ -19,7 +19,7 @@
 
 linestyle_str = [
      ('solid', 'solid'),      # Same as (0, ()) or '-'
-     ('dotted', 'dotted'),    # Same as (0, (1, 1)) or '.'
+     ('dotted', 'dotted'),    # Same as (0, (1, 1)) or ':'
      ('dashed', 'dashed'),    # Same as '--'
      ('dashdot', 'dashdot')]  # Same as '-.'
 
diff --git a/tutorials/introductory/customizing.py b/tutorials/introductory/customizing.py
@@ -138,6 +138,27 @@
 mpl.rc('lines', linewidth=4, linestyle='-.')
 plt.plot(data)
 
+###############################################################################
+# Temporary rc settings
+# ---------------------
+#
+# The :data:`matplotlib.rcParams` object can also be changed temporarily using
+# the `matplotlib.rc_context` context manager:
+
+with mpl.rc_context({'lines.linewidth': 2, 'lines.linestyle': ':'}):
+    plt.plot(data)
+
+###############################################################################
+# `matplotlib.rc_context` can also be used as a decorator to modify the
+# defaults within a function:
+
+
+@mpl.rc_context({'lines.linewidth': 3, 'lines.linestyle': '-'})
+def plotting_function():
+    plt.plot(data)
+
+plotting_function()
+
 ###############################################################################
 # `matplotlib.rcdefaults` will restore the standard Matplotlib
 # default settings.
