Discourage alternate strings for 'none' linestyle

timhoffm · timhoffm · commit 55320d3d339d · 2024-12-19T09:25:23.000+01:00
Inspired by but independent of the discussion around the representation of linestyles #29304. For other linestyles we have a short visual representation (e.g. "--") and a name (dashed "dashed"). No linestyle currently has four accepted writings "", " ", "none", "None". This PR recommends only to use "" (visual representation) and "none" (named representation). It discourages " " and "None". This should guide users towards more canonical usage. We may later decide whether to deprecate the alternatives. Note also, that we have not used the alternatives in examples.
diff --git a/lib/matplotlib/inset.py b/lib/matplotlib/inset.py
@@ -119,15 +119,15 @@ def set_linestyle(self, ls):
         """
         Set the linestyle of the rectangle and the connectors.
 
-        ==========================================  =================
-        linestyle                                   description
-        ==========================================  =================
-        ``'-'`` or ``'solid'``                      solid line
-        ``'--'`` or ``'dashed'``                    dashed line
-        ``'-.'`` or ``'dashdot'``                   dash-dotted line
-        ``':'`` or ``'dotted'``                     dotted line
-        ``'none'``, ``'None'``, ``' '``, or ``''``  draw nothing
-        ==========================================  =================
+        =======================================================  ================
+        linestyle                                                description
+        =======================================================  ================
+        ``'-'`` or ``'solid'``                                   solid line
+        ``'--'`` or ``'dashed'``                                 dashed line
+        ``'-.'`` or ``'dashdot'``                                dash-dotted line
+        ``':'`` or ``'dotted'``                                  dotted line
+        ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``)  draw nothing
+        =======================================================  ================
 
         Alternatively a dash tuple of the following form can be provided::
 
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -1152,15 +1152,15 @@ def set_linestyle(self, ls):
 
             - A string:
 
-              ==========================================  =================
-              linestyle                                   description
-              ==========================================  =================
-              ``'-'`` or ``'solid'``                      solid line
-              ``'--'`` or  ``'dashed'``                   dashed line
-              ``'-.'`` or  ``'dashdot'``                  dash-dotted line
-              ``':'`` or ``'dotted'``                     dotted line
-              ``'none'``, ``'None'``, ``' '``, or ``''``  draw nothing
-              ==========================================  =================
+              =======================================================  ================
+              linestyle                                                description
+              =======================================================  ================
+              ``'-'`` or ``'solid'``                                   solid line
+              ``'--'`` or ``'dashed'``                                 dashed line
+              ``'-.'`` or ``'dashdot'``                                dash-dotted line
+              ``':'`` or ``'dotted'``                                  dotted line
+              ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``)  draw nothing
+              =======================================================  ================
 
             - Alternatively a dash tuple of the following form can be
               provided::
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -445,15 +445,15 @@ def set_linestyle(self, ls):
         """
         Set the patch linestyle.
 
-        ==========================================  =================
-        linestyle                                   description
-        ==========================================  =================
-        ``'-'`` or ``'solid'``                      solid line
-        ``'--'`` or  ``'dashed'``                   dashed line
-        ``'-.'`` or  ``'dashdot'``                  dash-dotted line
-        ``':'`` or ``'dotted'``                     dotted line
-        ``'none'``, ``'None'``, ``' '``, or ``''``  draw nothing
-        ==========================================  =================
+        =======================================================  ================
+        linestyle                                                description
+        =======================================================  ================
+        ``'-'`` or ``'solid'``                                   solid line
+        ``'--'`` or ``'dashed'``                                 dashed line
+        ``'-.'`` or ``'dashdot'``                                dash-dotted line
+        ``':'`` or ``'dotted'``                                  dotted line
+        ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``)  draw nothing
+        =======================================================  ================
 
         Alternatively a dash tuple of the following form can be provided::
 
