Merge pull request #14931 from anntzer/rcvals

WeatherGod · web-flow · commit 2cc5d8d8c4ca · 2019-08-01T09:52:38.000-04:00
Deprecate some obscure rcParam synonyms.
diff --git a/doc/api/next_api_changes/2019-07-30-AL.rst b/doc/api/next_api_changes/2019-07-30-AL.rst
@@ -0,0 +1,7 @@
+API deprecations
+````````````````
+
+Setting :rc:`savefig.format` to "auto" is deprecated; use its synonym "png" instead.
+
+Setting :rc:`text.hinting` to True or False is deprecated; use their synonyms
+"auto" or "none" instead.
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -463,6 +463,10 @@ def update_savefig_format(value):
     # the new savefig.format does not.  We need to fix this here.
     value = validate_string(value)
     if value == 'auto':
+        cbook.warn_deprecated(
+            "3.2", message="Support for setting the 'savefig.format' rcParam "
+            "to 'auto' is deprecated since %(since)s and will be removed "
+            "%(removal)s; set it to 'png' instead.")
         value = 'png'
     return value
 
@@ -569,16 +573,15 @@ def validate_markevery(s):
      'upper center',
      'center'], ignorecase=True)
 
-
-def validate_svg_fonttype(s):
-    if s in ["none", "path"]:
-        return s
-    raise ValueError("Unrecognized svg.fonttype string '{}'; "
-                     "valid strings are 'none', 'path'")
+validate_svg_fonttype = ValidateInStrings('svg.fonttype', ['none', 'path'])
 
 
 def validate_hinting(s):
     if s in (True, False):
+        cbook.warn_deprecated(
+            "3.2", message="Support for setting the text.hinting rcParam to "
+            "True or False is deprecated since %(since)s and will be removed "
+            "%(removal)s; set it to its synonyms 'auto' or 'none' instead.")
         return s
     if s.lower() in ('auto', 'native', 'either', 'none'):
         return s.lower()
diff --git a/lib/matplotlib/testing/__init__.py b/lib/matplotlib/testing/__init__.py
@@ -20,7 +20,7 @@ def is_called_from_pytest():
 
 def set_font_settings_for_testing():
     mpl.rcParams['font.family'] = 'DejaVu Sans'
-    mpl.rcParams['text.hinting'] = False
+    mpl.rcParams['text.hinting'] = 'none'
     mpl.rcParams['text.hinting_factor'] = 8
 
 
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -313,8 +313,6 @@
                       ##               FreeType library supports it
                       ##     - either: Use the native hinting information,
                       ##               or the autohinter if none is available.
-                      ## For backward compatibility, this value may also be
-                      ##     True === 'auto' or False === 'none'.
 #text.hinting_factor : 8  ## Specifies the amount of softness for hinting in the
                           ## horizontal direction.  A value of 1 will hint to full
                           ## pixels.  A value of 2 will hint to half pixels etc.
