Skip to content

Commit 69619d8

Browse files
tqa236pmhatre1
tqa236
authored and
pmhatre1
committed
CI/DOC: Enforce PR02 in CI (pandas-dev#56971)
1 parent 0ed9ec4 commit 69619d8

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

‎ci/code_checks.sh

+128
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,134 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7777
pandas.DataFrame.to_sql # There should be no backslash in the final line, please keep this comment in the last ignored function
7878
RET=$(($RET + $?)) ; echo $MSG "DONE"
7979

80+
MSG='Partially validate docstrings (PR02)' ; echo $MSG
81+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR02 --ignore_functions \
82+
pandas.io.formats.style.Styler.to_excel\
83+
pandas.CategoricalIndex.rename_categories\
84+
pandas.CategoricalIndex.reorder_categories\
85+
pandas.CategoricalIndex.add_categories\
86+
pandas.CategoricalIndex.remove_categories\
87+
pandas.CategoricalIndex.set_categories\
88+
pandas.IntervalIndex.set_closed\
89+
pandas.IntervalIndex.contains\
90+
pandas.IntervalIndex.overlaps\
91+
pandas.IntervalIndex.to_tuples\
92+
pandas.DatetimeIndex.round\
93+
pandas.DatetimeIndex.floor\
94+
pandas.DatetimeIndex.ceil\
95+
pandas.DatetimeIndex.month_name\
96+
pandas.DatetimeIndex.day_name\
97+
pandas.DatetimeIndex.to_period\
98+
pandas.DatetimeIndex.std\
99+
pandas.TimedeltaIndex.round\
100+
pandas.TimedeltaIndex.floor\
101+
pandas.TimedeltaIndex.ceil\
102+
pandas.PeriodIndex\
103+
pandas.PeriodIndex.strftime\
104+
pandas.Series.clip\
105+
pandas.Series.rename_axis\
106+
pandas.Series.interpolate\
107+
pandas.Series.dt.to_period\
108+
pandas.Series.dt.tz_localize\
109+
pandas.Series.dt.tz_convert\
110+
pandas.Series.dt.strftime\
111+
pandas.Series.dt.round\
112+
pandas.Series.dt.floor\
113+
pandas.Series.dt.ceil\
114+
pandas.Series.dt.month_name\
115+
pandas.Series.dt.day_name\
116+
pandas.Series.str.count\
117+
pandas.Series.str.wrap\
118+
pandas.Series.cat.rename_categories\
119+
pandas.Series.cat.reorder_categories\
120+
pandas.Series.cat.add_categories\
121+
pandas.Series.cat.remove_categories\
122+
pandas.Series.cat.set_categories\
123+
pandas.Series.plot\
124+
pandas.Series.plot.bar\
125+
pandas.Series.plot.barh\
126+
pandas.Series.plot.line\
127+
pandas.Series.plot.pie\
128+
pandas.DataFrame.clip\
129+
pandas.DataFrame.interpolate\
130+
pandas.DataFrame.plot\
131+
pandas.DataFrame.plot.bar\
132+
pandas.DataFrame.plot.barh\
133+
pandas.DataFrame.plot.line\
134+
pandas.DataFrame.plot.pie\
135+
pandas.tseries.offsets.DateOffset\
136+
pandas.tseries.offsets.BusinessDay\
137+
pandas.tseries.offsets.BDay\
138+
pandas.tseries.offsets.BusinessHour\
139+
pandas.tseries.offsets.CustomBusinessDay\
140+
pandas.tseries.offsets.CDay\
141+
pandas.tseries.offsets.CustomBusinessHour\
142+
pandas.tseries.offsets.MonthEnd\
143+
pandas.tseries.offsets.MonthBegin\
144+
pandas.tseries.offsets.BusinessMonthEnd\
145+
pandas.tseries.offsets.BMonthEnd\
146+
pandas.tseries.offsets.BusinessMonthBegin\
147+
pandas.tseries.offsets.BMonthBegin\
148+
pandas.tseries.offsets.CustomBusinessMonthEnd\
149+
pandas.tseries.offsets.CBMonthEnd\
150+
pandas.tseries.offsets.CustomBusinessMonthBegin\
151+
pandas.tseries.offsets.CBMonthBegin\
152+
pandas.tseries.offsets.SemiMonthEnd\
153+
pandas.tseries.offsets.SemiMonthBegin\
154+
pandas.tseries.offsets.Week\
155+
pandas.tseries.offsets.WeekOfMonth\
156+
pandas.tseries.offsets.LastWeekOfMonth\
157+
pandas.tseries.offsets.BQuarterEnd\
158+
pandas.tseries.offsets.BQuarterBegin\
159+
pandas.tseries.offsets.QuarterEnd\
160+
pandas.tseries.offsets.QuarterBegin\
161+
pandas.tseries.offsets.BYearEnd\
162+
pandas.tseries.offsets.BYearBegin\
163+
pandas.tseries.offsets.YearEnd\
164+
pandas.tseries.offsets.YearBegin\
165+
pandas.tseries.offsets.FY5253\
166+
pandas.tseries.offsets.FY5253Quarter\
167+
pandas.tseries.offsets.Easter\
168+
pandas.tseries.offsets.Day\
169+
pandas.tseries.offsets.Hour\
170+
pandas.tseries.offsets.Minute\
171+
pandas.tseries.offsets.Second\
172+
pandas.tseries.offsets.Milli\
173+
pandas.tseries.offsets.Micro\
174+
pandas.tseries.offsets.Nano\
175+
pandas.describe_option\
176+
pandas.reset_option\
177+
pandas.get_option\
178+
pandas.set_option\
179+
pandas.Timestamp.max\
180+
pandas.Timestamp.min\
181+
pandas.Timestamp.resolution\
182+
pandas.Timedelta.max\
183+
pandas.Timedelta.min\
184+
pandas.Timedelta.resolution\
185+
pandas.Interval\
186+
pandas.Grouper\
187+
pandas.core.groupby.SeriesGroupBy.apply\
188+
pandas.core.groupby.DataFrameGroupBy.apply\
189+
pandas.core.groupby.SeriesGroupBy.transform\
190+
pandas.core.groupby.DataFrameGroupBy.transform\
191+
pandas.core.groupby.DataFrameGroupBy.nth\
192+
pandas.core.groupby.DataFrameGroupBy.rolling\
193+
pandas.core.groupby.SeriesGroupBy.idxmax\
194+
pandas.core.groupby.SeriesGroupBy.idxmin\
195+
pandas.core.groupby.SeriesGroupBy.nth\
196+
pandas.core.groupby.SeriesGroupBy.rolling\
197+
pandas.core.groupby.DataFrameGroupBy.hist\
198+
pandas.core.groupby.DataFrameGroupBy.plot\
199+
pandas.core.groupby.SeriesGroupBy.plot\
200+
pandas.read_hdf\
201+
pandas.HDFStore.append\
202+
pandas.core.window.rolling.Rolling.quantile\
203+
pandas.core.window.expanding.Expanding.quantile\
204+
pandas.core.resample.Resampler.interpolate\
205+
pandas.api.extensions.ExtensionArray.argsort # 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+
80208
fi
81209

82210
### DOCUMENTATION NOTEBOOKS ###

0 commit comments

Comments
 (0)