Merge pull request #16553 from tacaswell/doc_clarify_eventplot

timhoffm · web-flow · commit b3e6248cba08 · 2020-02-19T20:31:27.000+01:00
DOC: clarify the expected shapes of eventplot input
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1271,18 +1271,30 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
             The offset of the center of the lines from the origin, in the
             direction orthogonal to *orientation*.
 
+            A sequence must match the dimension of *positions*
+            in the direction of *orientation*.
+
         linelengths : scalar or sequence of scalars, default: 1
             The total height of the lines (i.e. the lines stretches from
             ``lineoffset - linelength/2`` to ``lineoffset + linelength/2``).
 
+            If a sequence, then *positions* must be 2D and the length
+            must match the first dimension of *positions*.
+
         linewidths : scalar, scalar sequence or None, default: None
             The line width(s) of the event lines, in points. If it is None,
             defaults to its rcParams setting.
 
+            If a sequence, then *positions* must be 2D and the length
+            must match the first dimension of *positions*.
+
         colors : color, sequence of colors or None, default: None
             The color(s) of the event lines. If it is None, defaults to its
             rcParams setting.
 
+            If a sequence, then *positions* must be 2D and the length
+            must match the first dimension of *positions*.
+
         linestyles : str or tuple or a sequence of such values, optional
             Default is 'solid'. Valid strings are ['solid', 'dashed',
             'dashdot', 'dotted', '-', '--', '-.', ':']. Dash tuples
@@ -1293,6 +1305,10 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
             where *onoffseq* is an even length tuple of on and off ink
             in points.
 
+            If a sequence, then *positions* must be 2D and the length
+            must match the first dimension of *positions*.
+
+
         **kwargs : optional
             Other keyword arguments are line collection properties.  See
             `.LineCollection` for a list of the valid properties.
