Skip to content

Commit

Permalink
DOC: fix docstrings validation for pandas.core.groupby.DataFrameGroup…
Browse files Browse the repository at this point in the history
…By.boxplot (#60509)

* fix docstrings validation for pandas.core.groupby.DataFrameGroupBy.boxplot

* fix trailing whitespace

* fix the error "pandas.Series.plot in `See Also` section does not need `pandas` prefix, use Series.plot instead."

* fix the error "pandas.DataFrame.boxplot in `See Also` section does not need `pandas` prefix, use DataFrame.boxplot instead."
  • Loading branch information
jmalp authored Dec 9, 2024
1 parent 6cbe941 commit ca91dd4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.arrays.IntervalArray.length SA01" \
-i "pandas.arrays.NumpyExtensionArray SA01" \
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
Expand Down
26 changes: 19 additions & 7 deletions pandas/plotting/_core.py
Original file line number Diff line number Diff line change
Expand Up @@ -570,18 +570,23 @@ def boxplot_frame_groupby(
Parameters
----------
grouped : Grouped DataFrame
grouped : DataFrameGroupBy
The grouped DataFrame object over which to create the box plots.
subplots : bool
* ``False`` - no subplots will be used
* ``True`` - create a subplot for each group.
column : column name or list of names, or vector
Can be any valid input to groupby.
fontsize : float or str
rot : label rotation angle
grid : Setting this to True will show the grid
Font size for the labels.
rot : float
Rotation angle of labels (in degrees) on the x-axis.
grid : bool
Whether to show grid lines on the plot.
ax : Matplotlib axis object, default None
figsize : A tuple (width, height) in inches
The axes on which to draw the plots. If None, uses the current axes.
figsize : tuple of (float, float)
The figure size in inches (width, height).
layout : tuple (optional)
The layout of the plot: (rows, columns).
sharex : bool, default False
Expand All @@ -599,8 +604,15 @@ def boxplot_frame_groupby(
Returns
-------
dict of key/value = group key/DataFrame.boxplot return value
or DataFrame.boxplot return value in case subplots=figures=False
dict or DataFrame.boxplot return value
If ``subplots=True``, returns a dictionary of group keys to the boxplot
return values. If ``subplots=False``, returns the boxplot return value
of a single DataFrame.
See Also
--------
DataFrame.boxplot : Create a box plot from a DataFrame.
Series.plot : Plot a Series.
Examples
--------
Expand Down

0 comments on commit ca91dd4

Please sign in to comment.