Rename rcparam contour.linewidths to contour.linewidth

stefraynaud · stefraynaud · commit f2f87e38e4c3 · 2020-05-06T13:55:19.000+02:00
diff --git a/doc/users/next_whats_new/2020-05-04-add-rcparams-contour-linewidth.rst b/doc/users/next_whats_new/2020-05-04-add-rcparams-contour-linewidth.rst
@@ -1,7 +1,7 @@
-Add :rc:`contour.linewidths` to rcParams
-----------------------------------------
+Add :rc:`contour.linewidth` to rcParams
+---------------------------------------
 
-The new config option :rc:`contour.linewidths` allows to control the default
+The new config option :rc:`contour.linewidth` allows to control the default
 linewidth of contours as a float. When set to ``None``, the linewidths fall
 back to :rc:`lines.linewidth`. The config value is overidden as usual
 by the ``linewidths`` argument passed to `~.axes.Axes.contour` when
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -1257,7 +1257,7 @@ def _process_linewidths(self):
         linewidths = self.linewidths
         Nlev = len(self.levels)
         if linewidths is None:
-            default_linewidth = mpl.rcParams['contour.linewidths']
+            default_linewidth = mpl.rcParams['contour.linewidth']
             if default_linewidth is None:
                 default_linewidth = mpl.rcParams['lines.linewidth']
             tlinewidths = [(default_linewidth,)] * Nlev
@@ -1752,7 +1752,7 @@ def _initialize_x_y(self, z):
             however introduce rendering artifacts at chunk boundaries depending
             on the backend, the *antialiased* flag and value of *alpha*.
 
-        linewidths : float or array-like, default: :rc:`contour.linewidths`
+        linewidths : float or array-like, default: :rc:`contour.linewidth`
             *Only applies to* `.contour`.
 
             The line width of the contour lines.
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -1195,7 +1195,7 @@ def _convert_validator_spec(key, conv):
     # contour props
     'contour.negative_linestyle': ['dashed', _validate_linestyle],
     'contour.corner_mask':        [True, validate_bool],
-    'contour.linewidths':        [None, validate_float_or_None],
+    'contour.linewidth':          [None, validate_float_or_None],
 
     # errorbar props
     'errorbar.capsize':      [0, validate_float],
diff --git a/lib/matplotlib/tests/test_contour.py b/lib/matplotlib/tests/test_contour.py
@@ -378,16 +378,16 @@ def test_contour_uneven():
 
 
 @pytest.mark.parametrize(
-    "rc_lines_linewidth, rc_contour_linewidths, call_linewidths, expected", [
+    "rc_lines_linewidth, rc_contour_linewidth, call_linewidths, expected", [
         (1.23, None, None, 1.23),
         (1.23, 4.24, None, 4.24),
         (1.23, 4.24, 5.02, 5.02)
         ])
-def test_contour_linewidths(
-        rc_lines_linewidth, rc_contour_linewidths, call_linewidths, expected):
+def test_contour_linewidth(
+        rc_lines_linewidth, rc_contour_linewidth, call_linewidths, expected):
 
     with rc_context(rc={"lines.linewidth": rc_lines_linewidth,
-                        "contour.linewidths": rc_contour_linewidths}):
+                        "contour.linewidth": rc_contour_linewidth}):
         fig, ax = plt.subplots()
         X = np.arange(4*3).reshape(4, 3)
         cs = ax.contour(X, linewidths=call_linewidths)
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -574,7 +574,7 @@
 ## ***************************************************************************
 #contour.negative_linestyle: dashed  # string or on-off ink sequence
 #contour.corner_mask:        True    # {True, False, legacy}
-#contour.linewidths :        None    # {float, None} Size of the contour
+#contour.linewidth:          None    # {float, None} Size of the contour
                                      # linewidths. If set to None,
                                      # it falls back to `line.linewidth`.
 
