Skip to content

updated hist documentation #19366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 1, 2018
Merged

updated hist documentation #19366

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad57628
updated hist documentation
mitchnegus Jan 24, 2018
7efb4f7
removed trailing whitespace for PEP8
mitchnegus Jan 24, 2018
d8aad5d
Merge branch 'master' into hist-doc
mitchnegus Jan 30, 2018
d0e44e4
added 'See Also' sections
mitchnegus Jan 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2156,10 +2156,18 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None,
The size of the figure to create in inches by default
layout : tuple, optional
Tuple of (rows, columns) for the layout of the histograms
bins : integer, default 10
Number of histogram bins to be used
bins : integer or sequence, default 10
Number of histogram bins to be used. If an integer is given, bins + 1
bin edges are calculated and returned. If bins is a sequence, gives
bin edges, including left edge of first bin and right edge of last
bin. In this case, bins is returned unmodified.
`**kwds` : other plotting keyword arguments
To be passed to hist function

Notes
-----
See matplotlib documentation online for more on this
Copy link
Member

@gfyoung gfyoung Jan 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you point to a specific matplotlib function(s) with a "See Also" section in the docstring? As given, if I were a new user, I wouldn't really have an idea of where to go.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

matplotlib.axes.Axes.hist might be turned into a link automatically, if you add it to "See Also".


"""
_converter._WARN = False
if by is not None:
Expand Down Expand Up @@ -2219,6 +2227,11 @@ def hist_series(self, by=None, ax=None, grid=True, xlabelsize=None,
rotation of y axis labels
figsize : tuple, default None
figure size in inches by default
bins : integer or sequence, default 10
Number of histogram bins to be used. If an integer is given, bins + 1
bin edges are calculated and returned. If bins is a sequence, gives
bin edges, including left edge of first bin and right edge of last
bin. In this case, bins is returned unmodified.
bins: integer, default 10
Number of histogram bins to be used
`**kwds` : keywords
Expand Down