Repository navigation
Commit 55320d3
committed
Discourage alternate strings for 'none' linestyle
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.1 parent 3aebcb7 commit 55320d3
3 files changed
Lines changed: 27 additions & 27 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -119,15 +119,15 @@ def set_linestyle(self, ls): | |||
| 119 | 119 | """ | |
| 120 | 120 | Set the linestyle of the rectangle and the connectors. | |
| 121 | 121 | ||
| 122 | - ========================================== ================= | ||
| 123 | - linestyle description | ||
| 124 | - ========================================== ================= | ||
| 125 | - ``'-'`` or ``'solid'`` solid line | ||
| 126 | - ``'--'`` or ``'dashed'`` dashed line | ||
| 127 | - ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 128 | - ``':'`` or ``'dotted'`` dotted line | ||
| 129 | - ``'none'``, ``'None'``, ``' '``, or ``''`` draw nothing | ||
| 130 | - ========================================== ================= | ||
| 122 | + ======================================================= ================ | ||
| 123 | + linestyle description | ||
| 124 | + ======================================================= ================ | ||
| 125 | + ``'-'`` or ``'solid'`` solid line | ||
| 126 | + ``'--'`` or ``'dashed'`` dashed line | ||
| 127 | + ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 128 | + ``':'`` or ``'dotted'`` dotted line | ||
| 129 | + ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``) draw nothing | ||
| 130 | + ======================================================= ================ | ||
| 131 | 131 | ||
| 132 | 132 | Alternatively a dash tuple of the following form can be provided:: | |
| 133 | 133 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1152,15 +1152,15 @@ def set_linestyle(self, ls): | |||
| 1152 | 1152 | ||
| 1153 | 1153 | - A string: | |
| 1154 | 1154 | ||
| 1155 | - ========================================== ================= | ||
| 1156 | - linestyle description | ||
| 1157 | - ========================================== ================= | ||
| 1158 | - ``'-'`` or ``'solid'`` solid line | ||
| 1159 | - ``'--'`` or ``'dashed'`` dashed line | ||
| 1160 | - ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 1161 | - ``':'`` or ``'dotted'`` dotted line | ||
| 1162 | - ``'none'``, ``'None'``, ``' '``, or ``''`` draw nothing | ||
| 1163 | - ========================================== ================= | ||
| 1155 | + ======================================================= ================ | ||
| 1156 | + linestyle description | ||
| 1157 | + ======================================================= ================ | ||
| 1158 | + ``'-'`` or ``'solid'`` solid line | ||
| 1159 | + ``'--'`` or ``'dashed'`` dashed line | ||
| 1160 | + ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 1161 | + ``':'`` or ``'dotted'`` dotted line | ||
| 1162 | + ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``) draw nothing | ||
| 1163 | + ======================================================= ================ | ||
| 1164 | 1164 | ||
| 1165 | 1165 | - Alternatively a dash tuple of the following form can be | |
| 1166 | 1166 | provided:: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -445,15 +445,15 @@ def set_linestyle(self, ls): | |||
| 445 | 445 | """ | |
| 446 | 446 | Set the patch linestyle. | |
| 447 | 447 | ||
| 448 | - ========================================== ================= | ||
| 449 | - linestyle description | ||
| 450 | - ========================================== ================= | ||
| 451 | - ``'-'`` or ``'solid'`` solid line | ||
| 452 | - ``'--'`` or ``'dashed'`` dashed line | ||
| 453 | - ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 454 | - ``':'`` or ``'dotted'`` dotted line | ||
| 455 | - ``'none'``, ``'None'``, ``' '``, or ``''`` draw nothing | ||
| 456 | - ========================================== ================= | ||
| 448 | + ======================================================= ================ | ||
| 449 | + linestyle description | ||
| 450 | + ======================================================= ================ | ||
| 451 | + ``'-'`` or ``'solid'`` solid line | ||
| 452 | + ``'--'`` or ``'dashed'`` dashed line | ||
| 453 | + ``'-.'`` or ``'dashdot'`` dash-dotted line | ||
| 454 | + ``':'`` or ``'dotted'`` dotted line | ||
| 455 | + ``''`` or ``'none'`` (discouraged: ``'None'``, ``' '``) draw nothing | ||
| 456 | + ======================================================= ================ | ||
| 457 | 457 | ||
| 458 | 458 | Alternatively a dash tuple of the following form can be provided:: | |
| 459 | 459 | ||
0 commit comments