Skip to content

Commit 478ed1a

Browse files
committed
[WIP] DOC Fixes pandas-dev#8447 Replaced matplotlib.hist by Series.hist and corrected format issues
1 parent c9d83bf commit 478ed1a

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

pandas/plotting/_core.py

+17-16
Original file line numberDiff line numberDiff line change
@@ -2001,9 +2001,9 @@ def plot_series(data, kind='line', ax=None, # Series unique
20012001
by some other columns. A box plot is a method for graphically depicting
20022002
groups of numerical data through their quartiles.
20032003
The box extends from the Q1 to Q3 quartile values of the data,
2004-
with a line at the median (Q2).The whiskers extend from the edges
2004+
with a line at the median (Q2). The whiskers extend from the edges
20052005
of box to show the range of the data. The position of the whiskers
2006-
is set by default to 1.5*IQR (IQR = Q3 - Q1) from the edges of the box.
2006+
is set by default to `1.5 * IQR (IQR = Q3 - Q1)` from the edges of the box.
20072007
Outlier points are those past the end of the whiskers.
20082008
20092009
For further details see
@@ -2031,7 +2031,7 @@ def plot_series(data, kind='line', ax=None, # Series unique
20312031
layout : tuple (rows, columns), optional
20322032
For example, (3, 5) will display the subplots
20332033
using 3 columns and 5 rows, starting from the top-left.
2034-
return_type : {None, 'axes', 'dict', 'both'}, default 'axes'
2034+
return_type : {'axes', 'dict', 'both'} or None, default 'axes'
20352035
The kind of object to return. The default is ``axes``.
20362036
20372037
* 'axes' returns the matplotlib axes the boxplot is drawn on.
@@ -2049,22 +2049,23 @@ def plot_series(data, kind='line', ax=None, # Series unique
20492049
20502050
Returns
20512051
-------
2052-
result:
2053-
Options:
2054-
2055-
* ax : object of class
2056-
matplotlib.axes.Axes (for ``return_type='axes'``)
2057-
* lines : dict (for ``return_type='dict'``)
2058-
* (ax, lines): namedtuple (for ``return_type='both'``)
2059-
* :class:`~pandas.Series` (for ``return_type != None``
2060-
and data grouped with ``by``)
2061-
* :class:`~numpy.array` (for ``return_type=None``
2062-
and data grouped with ``by``)
2052+
result :
2053+
2054+
The return type depends on the `return_type` parameter:
2055+
2056+
* 'axes' : object of class matplotlib.axes.Axes
2057+
* 'dict' : dict of matplotlib.lines.Line2D objects
2058+
* 'both' : a nametuple with strucure (ax, lines)
2059+
2060+
For data grouped with ``by``:
2061+
2062+
* :class:`~pandas.Series`
2063+
* :class:`~numpy.array` (for ``return_type = None``)
20632064
20642065
See Also
20652066
--------
2066-
matplotlib.pyplot.boxplot : Make a box and whisker plot.
2067-
matplotlib.pyplot.hist : Make a histogram.
2067+
Series.plot.hist: Make a histogram.
2068+
matplotlib.pyplot.boxplot : Matplotlib equivalent plot.
20682069
20692070
Notes
20702071
-----

0 commit comments

Comments
 (0)