8000 Fix some issues with docstring rendering · matplotlib/matplotlib@e70e5fd · GitHub
[go: up one dir, main page]

Skip to content

Commit e70e5fd

Browse files
committed
Fix some issues with docstring rendering
1 parent eecf1bd commit e70e5fd

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1113,11 +1113,12 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
11131113
*orientation* parameter).
11141114
11151115
orientation : {'horizontal', 'vertical'}, optional
1116+
Controls the direction of the event collections:
11161117
1117-
* 'horizontal' : the lines are arranged horizontally in rows,
1118-
and are vertical.
1119-
* 'vertical' : the lines are arranged vertically in columns,
1120-
and are horizontal.
1118+
- 'horizontal' : the lines are arranged horizontally in rows,
1119+
and are vertical.
1120+
- 'vertical' : the lines are arranged vertically in columns,
1121+
and are horizontal.
11211122
11221123
lineoffsets : scalar or sequence of scalars, optional, default: 1
11231124
The offset of the center of the lines from the origin, in the
@@ -1150,18 +1151,21 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
11501151
:class:`~matplotlib.collections.LineCollection` for a list of
11511152
the valid properties.
11521153
1153-
For *linelengths*, *linewidths*, *colors*, and *linestyles*, if only
1154-
a single value is given, that value is applied to all lines. If an
1155-
array-like is given, it must have the same length as positions, and
1156-
each value will be applied to the corresponding row or column of
1157-
events.
1158-
11591154
Returns
11601155
-------
11611156
11621157
A list of :class:`matplotlib.collections.EventCollection` objects that
11631158
were added.
11641159
1160+
Notes
1161+
-----
1162+
1163+
For *linelengths*, *linewidths*, *colors*, and *linestyles*, if only
1164+
a single value is given, that value is applied to all lines. If an
1165+
array-like is given, it must have the same length as *positions*, and
1166+
each value will be applied to the corresponding row or column of
1167+
events.
1168+
11651169
Example
11661170
-------
11671171

0 commit comments

Comments
 (0)
0