Merge pull request matplotlib#29343 from timhoffm/mnt-discourage-line…

…style MNT: Discourage alternate strings for 'none' linestyle
timhoffm · Dec 19, 2024 · a18354a · a18354a
2 parents 9db1b97 + 55320d3
commit a18354a
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 27 deletions.
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::