Extended docstring of set_linestyle

lennart0901 · lennart0901 · commit bea26348596e · 2014-10-24T14:07:02.000+02:00
and shortend type description to make travis happy
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -466,8 +466,17 @@ def set_linestyle(self, ls):
 
         Parameters
         ----------
-        ls : { '-',  '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted', (offset, on-off-dash-seq)}
-            The line style.  [[EXPLAIN on-off-dash-seq]]
+        ls : { '-',  '--', '-.', ':'} and more see description
+            The line style.  The written out linestyles
+            'solid', 'dashed', 'dashdot' and 'dotted' and drawstyle in
+            combination with a linestyle, e.g., ``'steps--'`` are also allowed.
+
+            Alternatively a dash tuple of the following form can be provided::
+
+                        (offset, onoffseq),
+
+            where ``onoffseq`` is an even length tuple of on and off ink
+            in points.
         """
         try:
             dashd = backend_bases.GraphicsContextBase.dashd
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -937,10 +937,17 @@ def set_linestyle(self, linestyle):
 
         Parameters
         ----------
-        ls : { '-',  '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted', (offset, on-off-dash-seq)}
-            The line style.  [[EXPLAIN on-off-dash-seq]]
-            Also accepts any drawstyle in combination with a linestyle,
-            e.g., ``'steps--'``.
+        ls : { '-',  '--', '-.', ':'} and more see description
+            The line style.  The written out linestyles
+            'solid', 'dashed', 'dashdot' and 'dotted' and drawstyle in
+            combination with a linestyle, e.g., ``'steps--'`` are also allowed.
+
+            Alternatively a dash tuple of the following form can be provided::
+
+                        (offset, onoffseq),
+
+            where ``onoffseq`` is an even length tuple of on and off ink
+            in points.
         """
         if not is_string_like(linestyle):
             if len(linestyle) != 2:
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -341,8 +341,17 @@ def set_linestyle(self, ls):
 
         Parameters
         ----------
-        ls : { '-',  '--', '-.', ':' , 'solid', 'dashed', 'dashdot', 'dotted', (offset, on-off-dash-seq)}
-            The line style.  [[EXPLAIN on-off-dash-seq]]
+        ls : { '-',  '--', '-.', ':'} and more see description
+            The line style.  The written out linestyles
+            'solid', 'dashed', 'dashdot' and 'dotted' and drawstyle in
+            combination with a linestyle, e.g., ``'steps--'`` are also allowed.
+
+            Alternatively a dash tuple of the following form can be provided::
+
+                        (offset, onoffseq),
+
+            where ``onoffseq`` is an even length tuple of on and off ink
+            in points.
         """
         if ls is None:
             ls = "solid"
