From ad5762823090d61973b1d24515e71c3bb42bc456 Mon Sep 17 00:00:00 2001 From: mitch Date: Tue, 23 Jan 2018 19:39:29 -0800 Subject: [PATCH 1/3] updated hist documentation --- pandas/plotting/_core.py | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 8b03d6ddde4ec..4e964bf2933b4 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -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 + """ _converter._WARN = False if by is not None: @@ -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 From 7efb4f7a7ed8ee37a76d09f30d989cd04da484ea Mon Sep 17 00:00:00 2001 From: mitch Date: Tue, 23 Jan 2018 19:50:10 -0800 Subject: [PATCH 2/3] removed trailing whitespace for PEP8 --- pandas/plotting/_core.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 4e964bf2933b4..da2e0cad24b4f 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2157,9 +2157,9 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None, layout : tuple, optional Tuple of (rows, columns) for the layout of the histograms 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 + 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 @@ -2228,9 +2228,9 @@ def hist_series(self, by=None, ax=None, grid=True, xlabelsize=None, 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 + 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 From d0e44e402537147c34bf9e9c98eaa8b593bb2200 Mon Sep 17 00:00:00 2001 From: mitch Date: Tue, 30 Jan 2018 12:48:51 -0800 Subject: [PATCH 3/3] added 'See Also' sections --- pandas/plotting/_core.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index da2e0cad24b4f..88b899ad60313 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2164,9 +2164,9 @@ def hist_frame(data, column=None, by=None, grid=True, xlabelsize=None, `**kwds` : other plotting keyword arguments To be passed to hist function - Notes - ----- - See matplotlib documentation online for more on this + See Also + -------- + matplotlib.axes.Axes.hist : Plot a histogram using matplotlib. """ _converter._WARN = False @@ -2237,9 +2237,9 @@ def hist_series(self, by=None, ax=None, grid=True, xlabelsize=None, `**kwds` : keywords To be passed to the actual plotting function - Notes - ----- - See matplotlib documentation online for more on this + See Also + -------- + matplotlib.axes.Axes.hist : Plot a histogram using matplotlib. """ import matplotlib.pyplot as plt