Merge pull request #16608 from anntzer/axisbelow

dstansby · web-flow · commit cfd4d3364e39 · 2020-03-01T15:40:02.000Z
Stricter validation of rcParams["axes.axisbelow"].
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -224,6 +224,12 @@ The following validators, defined in `.rcsetup`, are deprecated:
 value would be acceptable, one can test e.g. ``rc = RcParams(); rc[k] = v``
 raises an exception.
 
+Stricter rcParam validation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+:rc:`axes.axisbelow` currently normalizes all strings starting with "line"
+(case-insensitive) to the option "line".  This is deprecated; in a future
+version only the exact string "line" (case-sensitive) will be supported.
+
 Toggling axes navigation from the keyboard using "a" and digit keys
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Axes navigation can still be toggled programmatically using
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -180,8 +180,14 @@ def validate_axisbelow(s):
         return validate_bool(s)
     except ValueError:
         if isinstance(s, str):
-            s = s.lower()
-            if s.startswith('line'):
+            if s == 'line':
+                return 'line'
+            if s.lower().startswith('line'):
+                cbook.warn_deprecated(
+                    "3.3", message=f"Support for setting axes.axisbelow to "
+                    f"{s!r} to mean 'line' is deprecated since %(since)s and "
+                    f"will be removed in %(removal)s; set it to 'line' "
+                    "instead.")
                 return 'line'
     raise ValueError('%s cannot be interpreted as'
                      ' True, False, or "line"' % s)
