From 035e24573344f469520663927fcd812d3822590b Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Sun, 11 Feb 2024 01:37:13 -0700 Subject: [PATCH 1/2] Enforce SA05 in CI --- ci/code_checks.sh | 63 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 9c9cd2cc6650e..43537a439ca74 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -144,6 +144,69 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.core.groupby.SeriesGroupBy.plot # There should be no backslash in the final line, please keep this comment in the last ignored function RET=$(($RET + $?)) ; echo $MSG "DONE" + MSG='Partially validate docstrings (SA05)' ; echo $MSG + $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \ + pandas.core.resample.Resampler.last\ + pandas.core.window.expanding.Expanding.max\ + pandas.core.window.expanding.Expanding.skew\ + pandas.core.window.expanding.Expanding.count\ + pandas.core.window.expanding.Expanding.rank\ + pandas.core.window.rolling.Rolling.quantile\ + pandas.plotting.boxplot\ + pandas.core.window.expanding.Expanding.std\ + pandas.core.window.rolling.Rolling.corr\ + pandas.core.window.expanding.Expanding.sem\ + pandas.core.window.expanding.Expanding.kurt\ + pandas.DataFrame.agg\ + pandas.core.window.expanding.Expanding.var\ + pandas.core.window.rolling.Rolling.kurt\ + pandas.core.resample.Resampler.first\ + pandas.core.window.rolling.Window.mean\ + pandas.core.window.ewm.ExponentialMovingWindow.std\ + pandas.core.groupby.DataFrameGroupBy.first\ + pandas.core.window.rolling.Rolling.aggregate\ + pandas.core.window.rolling.Rolling.sem\ + pandas.core.window.rolling.Rolling.var\ + pandas.core.groupby.SeriesGroupBy.first\ + pandas.core.window.expanding.Expanding.sum\ + pandas.DataFrame.boxplot\ + pandas.core.window.ewm.ExponentialMovingWindow.var\ + pandas.core.groupby.SeriesGroupBy.last\ + pandas.core.window.rolling.Rolling.mean\ + pandas.plotting.radviz\ + pandas.core.groupby.DataFrameGroupBy.last\ + pandas.core.window.ewm.ExponentialMovingWindow.cov\ + pandas.plotting.bootstrap_plot\ + pandas.core.window.expanding.Expanding.quantile\ + pandas.core.window.expanding.Expanding.cov\ + pandas.core.window.rolling.Rolling.count\ + pandas.core.window.rolling.Rolling.min\ + pandas.core.window.expanding.Expanding.mean\ + pandas.arrays.ArrowStringArray\ + pandas.core.window.ewm.ExponentialMovingWindow.mean\ + pandas.core.window.expanding.Expanding.corr\ + pandas.core.window.rolling.Rolling.sum\ + pandas.core.window.rolling.Window.std\ + pandas.PeriodIndex.asfreq\ + pandas.core.window.rolling.Rolling.skew\ + pandas.core.window.rolling.Rolling.rank\ + pandas.core.window.ewm.ExponentialMovingWindow.corr\ + pandas.arrays.StringArray\ + pandas.core.window.rolling.Window.sum\ + pandas.core.window.rolling.Rolling.cov\ + pandas.core.window.expanding.Expanding.median\ + pandas.DataFrame.aggregate\ + pandas.core.window.rolling.Window.var\ + pandas.core.window.expanding.Expanding.aggregate\ + pandas.core.window.expanding.Expanding.min\ + pandas.core.window.ewm.ExponentialMovingWindow.sum\ + pandas.core.window.expanding.Expanding.apply\ + pandas.core.window.rolling.Rolling.median\ + pandas.core.window.rolling.Rolling.std\ + pandas.core.window.rolling.Rolling.max\ + pandas.core.window.rolling.Rolling.apply # There should be no backslash in the final line, please keep this comment in the last ignored function + RET=$(($RET + $?)) ; echo $MSG "DONE" + fi ### DOCUMENTATION NOTEBOOKS ### From b34c40dcf3250c916fffe20ba22e3742fbae4971 Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Sun, 11 Feb 2024 02:57:51 -0700 Subject: [PATCH 2/2] sorted SA05 functions in code_checks.sh --- ci/code_checks.sh | 94 +++++++++++++++++++++++------------------------ 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 43537a439ca74..bc3c5297ec4c4 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -146,65 +146,65 @@ 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.core.resample.Resampler.last\ - pandas.core.window.expanding.Expanding.max\ - pandas.core.window.expanding.Expanding.skew\ - pandas.core.window.expanding.Expanding.count\ - pandas.core.window.expanding.Expanding.rank\ - pandas.core.window.rolling.Rolling.quantile\ - pandas.plotting.boxplot\ - pandas.core.window.expanding.Expanding.std\ - pandas.core.window.rolling.Rolling.corr\ - pandas.core.window.expanding.Expanding.sem\ - pandas.core.window.expanding.Expanding.kurt\ pandas.DataFrame.agg\ - pandas.core.window.expanding.Expanding.var\ - pandas.core.window.rolling.Rolling.kurt\ - pandas.core.resample.Resampler.first\ - pandas.core.window.rolling.Window.mean\ - pandas.core.window.ewm.ExponentialMovingWindow.std\ + pandas.DataFrame.aggregate\ + pandas.DataFrame.boxplot\ + pandas.PeriodIndex.asfreq\ + pandas.arrays.ArrowStringArray\ + pandas.arrays.StringArray\ pandas.core.groupby.DataFrameGroupBy.first\ - pandas.core.window.rolling.Rolling.aggregate\ - pandas.core.window.rolling.Rolling.sem\ - pandas.core.window.rolling.Rolling.var\ + pandas.core.groupby.DataFrameGroupBy.last\ pandas.core.groupby.SeriesGroupBy.first\ - pandas.core.window.expanding.Expanding.sum\ - pandas.DataFrame.boxplot\ - pandas.core.window.ewm.ExponentialMovingWindow.var\ pandas.core.groupby.SeriesGroupBy.last\ - pandas.core.window.rolling.Rolling.mean\ - pandas.plotting.radviz\ - pandas.core.groupby.DataFrameGroupBy.last\ + pandas.core.resample.Resampler.first\ + pandas.core.resample.Resampler.last\ + pandas.core.window.ewm.ExponentialMovingWindow.corr\ pandas.core.window.ewm.ExponentialMovingWindow.cov\ - pandas.plotting.bootstrap_plot\ - pandas.core.window.expanding.Expanding.quantile\ + pandas.core.window.ewm.ExponentialMovingWindow.mean\ + pandas.core.window.ewm.ExponentialMovingWindow.std\ + pandas.core.window.ewm.ExponentialMovingWindow.sum\ + pandas.core.window.ewm.ExponentialMovingWindow.var\ + pandas.core.window.expanding.Expanding.aggregate\ + pandas.core.window.expanding.Expanding.apply\ + pandas.core.window.expanding.Expanding.corr\ + pandas.core.window.expanding.Expanding.count\ pandas.core.window.expanding.Expanding.cov\ + pandas.core.window.expanding.Expanding.kurt\ + pandas.core.window.expanding.Expanding.max\ + pandas.core.window.expanding.Expanding.mean\ + pandas.core.window.expanding.Expanding.median\ + pandas.core.window.expanding.Expanding.min\ + pandas.core.window.expanding.Expanding.quantile\ + pandas.core.window.expanding.Expanding.rank\ + pandas.core.window.expanding.Expanding.sem\ + pandas.core.window.expanding.Expanding.skew\ + pandas.core.window.expanding.Expanding.std\ + pandas.core.window.expanding.Expanding.sum\ + pandas.core.window.expanding.Expanding.var\ + pandas.core.window.rolling.Rolling.aggregate\ + pandas.core.window.rolling.Rolling.apply\ + pandas.core.window.rolling.Rolling.corr\ pandas.core.window.rolling.Rolling.count\ + pandas.core.window.rolling.Rolling.cov\ + pandas.core.window.rolling.Rolling.kurt\ + pandas.core.window.rolling.Rolling.max\ + pandas.core.window.rolling.Rolling.mean\ + pandas.core.window.rolling.Rolling.median\ pandas.core.window.rolling.Rolling.min\ - pandas.core.window.expanding.Expanding.mean\ - pandas.arrays.ArrowStringArray\ - pandas.core.window.ewm.ExponentialMovingWindow.mean\ - pandas.core.window.expanding.Expanding.corr\ + pandas.core.window.rolling.Rolling.quantile\ + pandas.core.window.rolling.Rolling.rank\ + pandas.core.window.rolling.Rolling.sem\ + pandas.core.window.rolling.Rolling.skew\ + pandas.core.window.rolling.Rolling.std\ pandas.core.window.rolling.Rolling.sum\ + pandas.core.window.rolling.Rolling.var\ + pandas.core.window.rolling.Window.mean\ pandas.core.window.rolling.Window.std\ - pandas.PeriodIndex.asfreq\ - pandas.core.window.rolling.Rolling.skew\ - pandas.core.window.rolling.Rolling.rank\ - pandas.core.window.ewm.ExponentialMovingWindow.corr\ - pandas.arrays.StringArray\ pandas.core.window.rolling.Window.sum\ - pandas.core.window.rolling.Rolling.cov\ - pandas.core.window.expanding.Expanding.median\ - pandas.DataFrame.aggregate\ pandas.core.window.rolling.Window.var\ - pandas.core.window.expanding.Expanding.aggregate\ - pandas.core.window.expanding.Expanding.min\ - pandas.core.window.ewm.ExponentialMovingWindow.sum\ - pandas.core.window.expanding.Expanding.apply\ - pandas.core.window.rolling.Rolling.median\ - pandas.core.window.rolling.Rolling.std\ - pandas.core.window.rolling.Rolling.max\ - pandas.core.window.rolling.Rolling.apply # There should be no backslash in the final line, please keep this comment in the last ignored function + pandas.plotting.bootstrap_plot\ + pandas.plotting.boxplot\ + pandas.plotting.radviz # There should be no backslash in the final line, please keep this comment in the last ignored function RET=$(($RET + $?)) ; echo $MSG "DONE" fi