Merge pull request #24354 from tacaswell/doc_rccontext

timhoffm · web-flow · commit aca6e9d5e988 · 2022-11-03T21:08:57.000+01:00
DOC: clarify rc_context resets all rcParams changes
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1071,6 +1071,9 @@ def rc_context(rc=None, fname=None):
 
     The :rc:`backend` will not be reset by the context manager.
 
+    rcParams changed both through the context manager invocation and
+    in the body of the context will be reset on context exit.
+
     Parameters
     ----------
     rc : dict
@@ -1098,6 +1101,13 @@ def rc_context(rc=None, fname=None):
          with mpl.rc_context(fname='print.rc'):
              plt.plot(x, y)  # uses 'print.rc'
 
+    Setting in the context body::
+
+        with mpl.rc_context():
+            # will be reset
+            mpl.rcParams['lines.linewidth'] = 5
+            plt.plot(x, y)
+
     """
     orig = dict(rcParams.copy())
     del orig['backend']
