Skip to content

Commit ca91dd4

Browse files
authored
DOC: fix docstrings validation for pandas.core.groupby.DataFrameGroupBy.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."
1 parent 6cbe941 commit ca91dd4

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
8484
-i "pandas.arrays.IntervalArray.length SA01" \
8585
-i "pandas.arrays.NumpyExtensionArray SA01" \
8686
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
87-
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
8887
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
8988
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
9089
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \

pandas/plotting/_core.py

+19-7
Original file line numberDiff line numberDiff line change
@@ -570,18 +570,23 @@ def boxplot_frame_groupby(
570570
571571
Parameters
572572
----------
573-
grouped : Grouped DataFrame
573+
grouped : DataFrameGroupBy
574+
The grouped DataFrame object over which to create the box plots.
574575
subplots : bool
575576
* ``False`` - no subplots will be used
576577
* ``True`` - create a subplot for each group.
577-
578578
column : column name or list of names, or vector
579579
Can be any valid input to groupby.
580580
fontsize : float or str
581-
rot : label rotation angle
582-
grid : Setting this to True will show the grid
581+
Font size for the labels.
582+
rot : float
583+
Rotation angle of labels (in degrees) on the x-axis.
584+
grid : bool
585+
Whether to show grid lines on the plot.
583586
ax : Matplotlib axis object, default None
584-
figsize : A tuple (width, height) in inches
587+
The axes on which to draw the plots. If None, uses the current axes.
588+
figsize : tuple of (float, float)
589+
The figure size in inches (width, height).
585590
layout : tuple (optional)
586591
The layout of the plot: (rows, columns).
587592
sharex : bool, default False
@@ -599,8 +604,15 @@ def boxplot_frame_groupby(
599604
600605
Returns
601606
-------
602-
dict of key/value = group key/DataFrame.boxplot return value
603-
or DataFrame.boxplot return value in case subplots=figures=False
607+
dict or DataFrame.boxplot return value
608+
If ``subplots=True``, returns a dictionary of group keys to the boxplot
609+
return values. If ``subplots=False``, returns the boxplot return value
610+
of a single DataFrame.
611+
612+
See Also
613+
--------
614+
DataFrame.boxplot : Create a box plot from a DataFrame.
615+
Series.plot : Plot a Series.
604616
605617
Examples
606618
--------

0 commit comments

Comments
 (0)