clarified sketch params format

story645 · story645 · commit 6d35de0d25a9 · 2023-09-22T00:23:27.000-04:00
diff --git a/lib/matplotlib/mpl-data/matplotlibrc b/lib/matplotlib/mpl-data/matplotlibrc
@@ -669,14 +669,14 @@
 #path.snap: True  # When True, rectilinear axis-aligned paths will be snapped
                   # to the nearest pixel when certain criteria are met.
                   # When False, paths will never be snapped.
-#path.sketch: None  # May be None, or a 3-tuple of the form:
-                    # (scale, length, randomness).
-                    #     - *scale* is the amplitude of the wiggle
-                    #         perpendicular to the line (in pixels).
-                    #     - *length* is the length of the wiggle along the
-                    #         line (in pixels).
-                    #     - *randomness* is the factor by which the length is
-                    #         randomly scaled.
+#path.sketch: None  # May be None, or a triplet of the form:
+                    #  path.sketch: scale, length, randomness 
+                    # - *scale* is the amplitude of the wiggle
+                    #    perpendicular to the line (in pixels).
+                    # - *length* is the length of the wiggle along the
+                    #    line (in pixels).
+                    # - *randomness* is the factor by which the length is
+                    #    randomly scaled.
 #path.effects:
 #path.effects.withStroke: None  # {"argument":value } passed to withStroke
 
diff --git a/lib/matplotlib/mpl-data/stylelib/xkcd.mplstyle b/lib/matplotlib/mpl-data/stylelib/xkcd.mplstyle
@@ -26,5 +26,5 @@ grid.linewidth: 0.0
 figure.facecolor: white
 
 # path
-path.sketch             : (1, 100, 2)
+path.sketch             : 1, 100, 2
 path.effects.withStroke : {"linewidth": 4, "foreground": 'w' }
diff --git a/lib/matplotlib/rcsetup.py b/lib/matplotlib/rcsetup.py
@@ -562,7 +562,7 @@ def validate_sketch(s):
     try:
         return tuple(_listify_validator(validate_float, n=3)(s))
     except ValueError:
-        raise ValueError("Expected a (scale, length, randomness) triplet")
+        raise ValueError("Expected a 'scale, length, randomness' triplet")
 
 
 def _validate_greaterthan_minushalf(s):
