Make EventCollection behavior consistent with docstring

afvincent · afvincent · commit b1a7ad968995 · 2017-03-19T23:48:29.000+01:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1132,7 +1132,7 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         linestyles : str or tuple or a sequence of such values, optional.
             Default is 'solid'. Valid strings are [ 'solid' | 'dashed' |
             'dashdot' | 'dotted' | '-' | '--' | '-.' | ':' ]. Dash tuples
-            have to follow::
+            have to be of the form::
 
                 (offset, onoffseq),
 
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1251,7 +1251,7 @@ class EventCollection(LineCollection):
     _edge_default = True
 
     def __init__(self,
-                 positions,     # Can be None.
+                 positions,     # Cannot be None.
                  orientation=None,
                  lineoffset=0,
                  linelength=1,
@@ -1264,7 +1264,7 @@ def __init__(self,
         """
         Parameters
         ----------
-        positions : 1D array-like object or None.
+        positions : 1D array-like object.
             Each value is an event.
 
         orientation : [ None (default) | 'horizontal' | 'vertical'], optional.
@@ -1286,9 +1286,8 @@ def __init__(self,
             If it is None, defaults to its rcParams setting, in sequence form.
 
         linestyle : str or tuple, optional. Default is 'solid'.
-            If it is a string, it has to be among [ 'solid' | 'dashed' |
-            'dashdot' | 'dotted' | '-' | '--' | '-.' | ':' ]. If it is a dash
-            tuple, it has to be of the form::
+            Valid strings are [ 'solid' | 'dashed' | 'dashdot' | 'dotted' |
+            '-' | '--' | '-.' | ':' ]. Dash tuples have to be of the form::
 
                 (offset, onoffseq),
 
@@ -1311,11 +1310,12 @@ def __init__(self,
 
         segment = (lineoffset + linelength / 2.,
                    lineoffset - linelength / 2.)
+        positions = np.asarray(positions)
         if len(positions) == 0:
             segments = []
-        elif hasattr(positions, 'ndim') and positions.ndim > 1:
-            raise ValueError('if positions is an ndarray it cannot have '
-                             'dimensionality strictly greater than 1 ')
+        elif positions.ndim > 1:
+            raise ValueError('positions cannot have a dimensionality greater '
+                             'than 1 (in the ndarray sense)')
         elif (orientation is None or orientation.lower() == 'none' or
               orientation.lower() == 'horizontal'):
             positions.sort()
