Merge pull request #20540 from anntzer/enc

tacaswell · web-flow · commit 189dba3a063c · 2021-06-28T12:30:57.000-04:00
Deprecate :encoding: option to .. plot::, which has no effect since 2011
diff --git a/doc/api/next_api_changes/deprecations/20540-AL.rst b/doc/api/next_api_changes/deprecations/20540-AL.rst
@@ -0,0 +1,3 @@
+``:encoding:`` option to ``.. plot`` directive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This option has had no effect since Matplotlib 1.3.1, and is now deprecated.
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -196,6 +196,11 @@ def _option_format(arg):
     return directives.choice(arg, ('python', 'doctest'))
 
 
+def _deprecated_option_encoding(arg):
+    _api.warn_deprecated("3.5", "encoding", obj_type="option")
+    return directives.encoding(arg)
+
+
 def mark_plot_labels(app, document):
     """
     To make plots referenceable, we need to move the reference from the
@@ -244,7 +249,7 @@ class PlotDirective(Directive):
         'format': _option_format,
         'context': _option_context,
         'nofigs': directives.flag,
-        'encoding': directives.encoding,
+        'encoding': _deprecated_option_encoding,
         'caption': directives.unchanged,
         }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``:encoding:`` option to ``.. plot`` directive
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+This option has had no effect since Matplotlib 1.3.1, and is now deprecated.`