Permalink
Browse files

DOC mentions kwargs in vlines and hlines

  • Loading branch information...
1 parent 58458de commit ec54a0bb456cee56e80e56691a5c91c854bf5688 @NelleV committed Feb 28, 2013
Showing with 19 additions and 15 deletions.
  1. +19 −15 lib/matplotlib/axes.py
View
@@ -3667,25 +3667,27 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
Respective beginning and end of each line. If scalars are
provided, all lines will have same length.
- colors : a line collections color argument, either a single color
- or a list of colors
+ colors : array_like of colors, optional, default: 'k'
- linestyles : ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional,
- default : 'solid'
+ linestyles : ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional
label : string, optional, default: ''
Returns
-------
- :class:`~matplotlib.collections.LineCollection`
+ matplotlib.collections.LineCollection
- Example
- --------
+ Other parameters
+ ----------------
+ kwargs correspond to matplotlib.collections.LineCollection properties.
+
+ Notes
+ -----
.. plot:: mpl_examples/pylab_examples/vline_hline_demo.py
See also
--------
- vlines : horizontal lines
+ vlines : vertical lines
"""
# We do the conversion first since not all unitized data is uniform
@@ -3753,20 +3755,22 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
Respective beginning and end of each line. If scalars are
provided, all lines will have same length.
- colors : a line collections color argument, either a single color
- or a list of colors
+ colors : array_like of colors, optional, default: 'k'
- linestyles : ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional,
- default : 'solid'
+ linestyles : ['solid' | 'dashed' | 'dashdot' | 'dotted'], optional
label : string, optional, default: ''
Returns
-------
- :class:`~matplotlib.collections.LineCollection`
+ matplotlib.collections.LineCollection
- Example
- -------
+ Other parameters
+ ----------------
+ kwargs correspond to matplotlib.collections.LineCollection properties.
+
+ Notes
+ -----
.. plot:: mpl_examples/pylab_examples/vline_hline_demo.py
See also

0 comments on commit ec54a0b

Please sign in to comment.