Skip to content

Commit 8898b45

Browse files
committed
DOC: Improve dosctring for pandas.DataFrame.hist
1 parent 4131149 commit 8898b45

File tree

1 file changed

+36
-14
lines changed

1 file changed

+36
-14
lines changed

Diff for: pandas/plotting/_core.py

+36-14
Original file line numberDiff line numberDiff line change
@@ -2130,48 +2130,70 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None,
21302130
"""
21312131
Draw histogram of the DataFrame's series using matplotlib / pylab.
21322132
2133+
A histogram is a representation of the distribution of numerical data.
2134+
This function wraps the matplotlib histogram function for each serie in
2135+
the DataFrame. It returns an array with a plot for each histogram.
2136+
21332137
Parameters
21342138
----------
21352139
data : DataFrame
2140+
The pandas object holding the data.
21362141
column : string or sequence
2137-
If passed, will be used to limit data to a subset of columns
2142+
If passed, will be used to limit data to a subset of columns.
21382143
by : object, optional
2139-
If passed, then used to form histograms for separate groups
2144+
If passed, then used to form histograms for separate groups.
21402145
grid : boolean, default True
2141-
Whether to show axis grid lines
2146+
Whether to show axis grid lines.
21422147
xlabelsize : int, default None
2143-
If specified changes the x-axis label size
2148+
If specified changes the x-axis label size.
21442149
xrot : float, default None
2145-
rotation of x axis labels
2150+
Rotation of x axis labels.
21462151
ylabelsize : int, default None
2147-
If specified changes the y-axis label size
2152+
If specified changes the y-axis label size.
21482153
yrot : float, default None
2149-
rotation of y axis labels
2150-
ax : matplotlib axes object, default None
2154+
Rotation of y axis labels.
2155+
ax : Matplotlib axes object, default None
2156+
The histogram axes.
21512157
sharex : boolean, default True if ax is None else False
21522158
In case subplots=True, share x axis and set some x axis labels to
21532159
invisible; defaults to True if ax is None otherwise False if an ax
21542160
is passed in; Be aware, that passing in both an ax and sharex=True
2155-
will alter all x axis labels for all subplots in a figure!
2161+
will alter all x axis labels for all subplots in a figure!.
21562162
sharey : boolean, default False
21572163
In case subplots=True, share y axis and set some y axis labels to
2158-
invisible
2164+
invisible.
21592165
figsize : tuple
2160-
The size of the figure to create in inches by default
2166+
The size of the figure to create in inches by default.
21612167
layout : tuple, optional
2162-
Tuple of (rows, columns) for the layout of the histograms
2168+
Tuple of (rows, columns) for the layout of the histograms.
21632169
bins : integer or sequence, default 10
21642170
Number of histogram bins to be used. If an integer is given, bins + 1
21652171
bin edges are calculated and returned. If bins is a sequence, gives
21662172
bin edges, including left edge of first bin and right edge of last
21672173
bin. In this case, bins is returned unmodified.
2168-
`**kwds` : other plotting keyword arguments
2169-
To be passed to hist function
2174+
kwds : Keyword Arguments
2175+
All other plotting keyword arguments to be passed to
2176+
matplotlib's boxplot function.
2177+
2178+
Returns
2179+
-------
2180+
axes : matplotlib.AxesSubplot or np.array of them
21702181
21712182
See Also
21722183
--------
21732184
matplotlib.axes.Axes.hist : Plot a histogram using matplotlib.
21742185
2186+
Examples
2187+
--------
2188+
2189+
.. plot::
2190+
:context: close-figs
2191+
2192+
>>> df = pd.DataFrame({
2193+
... 'length': [ 1.5, 0.5, 1.2, 0.9, 3],
2194+
... 'width': [ 0.7, 0.2, 0.15, 0.2, 1.1]
2195+
... }, index= ['pig', 'rabbit', 'duck', 'chicken', 'horse'])
2196+
>>> hist = df.hist(bins=3)
21752197
"""
21762198
_converter._WARN = False
21772199
if by is not None:

0 commit comments

Comments
 (0)