Skip to content

Commit 2393a13

Browse files
CI/DOC: Enforce SA05 in CI (#57352)
* Enforce SA05 in CI * sorted SA05 functions in code_checks.sh
1 parent 67bab76 commit 2393a13

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

ci/code_checks.sh

+63
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,69 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
142142
pandas.core.groupby.SeriesGroupBy.plot # There should be no backslash in the final line, please keep this comment in the last ignored function
143143
RET=$(($RET + $?)) ; echo $MSG "DONE"
144144

145+
MSG='Partially validate docstrings (SA05)' ; echo $MSG
146+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \
147+
pandas.DataFrame.agg\
148+
pandas.DataFrame.aggregate\
149+
pandas.DataFrame.boxplot\
150+
pandas.PeriodIndex.asfreq\
151+
pandas.arrays.ArrowStringArray\
152+
pandas.arrays.StringArray\
153+
pandas.core.groupby.DataFrameGroupBy.first\
154+
pandas.core.groupby.DataFrameGroupBy.last\
155+
pandas.core.groupby.SeriesGroupBy.first\
156+
pandas.core.groupby.SeriesGroupBy.last\
157+
pandas.core.resample.Resampler.first\
158+
pandas.core.resample.Resampler.last\
159+
pandas.core.window.ewm.ExponentialMovingWindow.corr\
160+
pandas.core.window.ewm.ExponentialMovingWindow.cov\
161+
pandas.core.window.ewm.ExponentialMovingWindow.mean\
162+
pandas.core.window.ewm.ExponentialMovingWindow.std\
163+
pandas.core.window.ewm.ExponentialMovingWindow.sum\
164+
pandas.core.window.ewm.ExponentialMovingWindow.var\
165+
pandas.core.window.expanding.Expanding.aggregate\
166+
pandas.core.window.expanding.Expanding.apply\
167+
pandas.core.window.expanding.Expanding.corr\
168+
pandas.core.window.expanding.Expanding.count\
169+
pandas.core.window.expanding.Expanding.cov\
170+
pandas.core.window.expanding.Expanding.kurt\
171+
pandas.core.window.expanding.Expanding.max\
172+
pandas.core.window.expanding.Expanding.mean\
173+
pandas.core.window.expanding.Expanding.median\
174+
pandas.core.window.expanding.Expanding.min\
175+
pandas.core.window.expanding.Expanding.quantile\
176+
pandas.core.window.expanding.Expanding.rank\
177+
pandas.core.window.expanding.Expanding.sem\
178+
pandas.core.window.expanding.Expanding.skew\
179+
pandas.core.window.expanding.Expanding.std\
180+
pandas.core.window.expanding.Expanding.sum\
181+
pandas.core.window.expanding.Expanding.var\
182+
pandas.core.window.rolling.Rolling.aggregate\
183+
pandas.core.window.rolling.Rolling.apply\
184+
pandas.core.window.rolling.Rolling.corr\
185+
pandas.core.window.rolling.Rolling.count\
186+
pandas.core.window.rolling.Rolling.cov\
187+
pandas.core.window.rolling.Rolling.kurt\
188+
pandas.core.window.rolling.Rolling.max\
189+
pandas.core.window.rolling.Rolling.mean\
190+
pandas.core.window.rolling.Rolling.median\
191+
pandas.core.window.rolling.Rolling.min\
192+
pandas.core.window.rolling.Rolling.quantile\
193+
pandas.core.window.rolling.Rolling.rank\
194+
pandas.core.window.rolling.Rolling.sem\
195+
pandas.core.window.rolling.Rolling.skew\
196+
pandas.core.window.rolling.Rolling.std\
197+
pandas.core.window.rolling.Rolling.sum\
198+
pandas.core.window.rolling.Rolling.var\
199+
pandas.core.window.rolling.Window.mean\
200+
pandas.core.window.rolling.Window.std\
201+
pandas.core.window.rolling.Window.sum\
202+
pandas.core.window.rolling.Window.var\
203+
pandas.plotting.bootstrap_plot\
204+
pandas.plotting.boxplot\
205+
pandas.plotting.radviz # There should be no backslash in the final line, please keep this comment in the last ignored function
206+
RET=$(($RET + $?)) ; echo $MSG "DONE"
207+
145208
fi
146209

147210
### DOCUMENTATION NOTEBOOKS ###

0 commit comments

Comments
 (0)