Skip to content

Commit c2305c9

Browse files
committed
Changed docstrings as tacaswell suggested
1 parent 7da45dd commit c2305c9

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

lib/matplotlib/collections.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,12 @@ def set_linestyle(self, ls):
463463
"""
464464
Set the linestyle(s) for the collection.
465465
466-
ACCEPTS: [ '-' | '--' | '-.' | ':' |
467-
'solid' | 'dashed', 'dashdot', 'dotted' |
468-
(offset, on-off-dash-seq) ]
466+
467+
Parameters
468+
----------
469+
ls : { '-', '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted',
470+
(offset, on-off-dash-seq)}
471+
The line style. [[EXPLAIN on-off-dash-seq]]
469472
"""
470473
try:
471474
dashd = backend_bases.GraphicsContextBase.dashd

lib/matplotlib/lines.py

+10-7
Original file line numberDiff line numberDiff line change
@@ -909,17 +909,17 @@ def set_linestyle(self, linestyle):
909909
Set the linestyle of the line (also accepts drawstyles)
910910
911911
912-
================ =================
912+
=========================== =================
913913
linestyle description
914-
================ =================
914+
=========================== =================
915915
``'-'`` or ``'solid'`` solid line
916916
``'--'`` or ``'dashed'`` dashed line
917917
``'-.'`` or ``'dash_dot'`` dash-dotted line
918918
``':'`` or ``'dotted'`` dotted line
919919
``'None'`` draw nothing
920920
``' '`` draw nothing
921921
``''`` draw nothing
922-
================ =================
922+
=========================== =================
923923
924924
'steps' is equivalent to 'steps-pre' and is maintained for
925925
backward-compatibility.
@@ -929,10 +929,13 @@ def set_linestyle(self, linestyle):
929929
:meth:`set_drawstyle`
930930
To set the drawing style (stepping) of the plot.
931931
932-
ACCEPTS: [``'-'`` | ``'--'`` | ``'-.'`` | ``':'`` |
933-
``'solid'`` | ``'dashed'`` | ``'dash_dot'`` | ``'dotted'`` |
934-
``'None'`` | ``' '`` | ``''``]
935-
and any drawstyle in combination with a linestyle, e.g., ``'steps--'``.
932+
Parameters
933+
----------
934+
ls : { '-', '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted',
935+
(offset, on-off-dash-seq)}
936+
The line style. [[EXPLAIN on-off-dash-seq]]
937+
Also accepts any drawstyle in combination with a linestyle,
938+
e.g., ``'steps--'``.
936939
"""
937940
if not is_string_like(linestyle):
938941
if len(linestyle) != 2:

lib/matplotlib/patches.py

+5-3
Original file line numberDiff line numberDiff line change
@@ -339,9 +339,11 @@ def set_linestyle(self, ls):
339339
"""
340340
Set the patch linestyle
341341
342-
ACCEPTS: ['-' | '--' | '-.' | ':' |
343-
'solid' | 'dashed' | 'dashdot' | 'dotted' |
344-
(offset, on-off-dash-seq) ]
342+
Parameters
343+
----------
344+
ls : { '-', '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted',
345+
(offset, on-off-dash-seq)}
346+
The line style. [[EXPLAIN on-off-dash-seq]]
345347
"""
346348
if ls is None:
347349
ls = "solid"

0 commit comments

Comments
 (0)