Skip to content

DOC: fix SA05 errors in docstring for pandas.DataFrame - agg, aggregate, boxplot #57404

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 1 commit into from
Feb 13, 2024
Merged

DOC: fix SA05 errors in docstring for pandas.DataFrame - agg, aggregate, boxplot #57404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (SA05)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \
pandas.DataFrame.agg\
pandas.DataFrame.aggregate\
pandas.DataFrame.boxplot\
pandas.PeriodIndex.asfreq\
pandas.arrays.ArrowStringArray\
pandas.arrays.StringArray\
Expand Down
10 changes: 5 additions & 5 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9752,11 +9752,11 @@ def _gotitem(
--------
DataFrame.apply : Perform any type of operations.
DataFrame.transform : Perform transformation type operations.
pandas.DataFrame.groupby : Perform operations over groups.
pandas.DataFrame.resample : Perform operations over resampled bins.
pandas.DataFrame.rolling : Perform operations over rolling window.
pandas.DataFrame.expanding : Perform operations over expanding window.
pandas.core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
DataFrame.groupby : Perform operations over groups.
DataFrame.resample : Perform operations over resampled bins.
DataFrame.rolling : Perform operations over rolling window.
DataFrame.expanding : Perform operations over expanding window.
core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
weighted window.
"""
)
Expand Down
2 changes: 1 addition & 1 deletion pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ def hist_frame(

See Also
--------
pandas.Series.plot.hist: Make a histogram.
Series.plot.hist: Make a histogram.
matplotlib.pyplot.boxplot : Matplotlib equivalent plot.

Notes
Expand Down