From ca91dd4c39a02c0026b98c16c56996f81506e004 Mon Sep 17 00:00:00 2001
From: jmalp <75514361+jmalp@users.noreply.github.com>
Date: Mon, 9 Dec 2024 10:54:40 -0800
Subject: [PATCH] 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."
---
ci/code_checks.sh | 1 -
pandas/plotting/_core.py | 26 +++++++++++++++++++-------
2 files changed, 19 insertions(+), 8 deletions(-)
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
index 7bc220acdd..fdaffb5a9c 100755
--- a/ci/code_checks.sh
+++ b/ci/code_checks.sh
@@ -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" \
diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py
index fbf9009ced..aee872f9ae 100644
--- a/pandas/plotting/_core.py
+++ b/pandas/plotting/_core.py
@@ -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
@@ -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
--------
--
GitLab