Skip to content

Commit 1ed627a

Browse files
CI/DOC: Enforce PR01 in CI (#57358)
Enforce PR01 in CI
1 parent c437277 commit 1ed627a

File tree

1 file changed

+325
-0
lines changed

1 file changed

+325
-0
lines changed

ci/code_checks.sh

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

144+
MSG='Partially validate docstrings (PR01)' ; echo $MSG
145+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR01 --ignore_functions \
146+
pandas.Categorical\
147+
pandas.Categorical.__array__\
148+
pandas.CategoricalIndex.equals\
149+
pandas.CategoricalIndex.map\
150+
pandas.DataFrame.at_time\
151+
pandas.DataFrame.backfill\
152+
pandas.DataFrame.get\
153+
pandas.DataFrame.pad\
154+
pandas.DataFrame.sem\
155+
pandas.DataFrame.sparse\
156+
pandas.DataFrame.std\
157+
pandas.DataFrame.swapaxes\
158+
pandas.DataFrame.var\
159+
pandas.DatetimeIndex.indexer_at_time\
160+
pandas.DatetimeIndex.snap\
161+
pandas.DatetimeIndex.std\
162+
pandas.ExcelFile\
163+
pandas.ExcelFile.parse\
164+
pandas.Grouper\
165+
pandas.HDFStore.append\
166+
pandas.HDFStore.put\
167+
pandas.Index.get_indexer_for\
168+
pandas.Index.identical\
169+
pandas.Index.putmask\
170+
pandas.Index.ravel\
171+
pandas.Index.str\
172+
pandas.Index.take\
173+
pandas.IntervalDtype\
174+
pandas.MultiIndex\
175+
pandas.Period.strftime\
176+
pandas.RangeIndex.from_range\
177+
pandas.Series.at_time\
178+
pandas.Series.backfill\
179+
pandas.Series.cat.add_categories\
180+
pandas.Series.cat.as_ordered\
181+
pandas.Series.cat.as_unordered\
182+
pandas.Series.cat.remove_categories\
183+
pandas.Series.cat.remove_unused_categories\
184+
pandas.Series.cat.rename_categories\
185+
pandas.Series.cat.reorder_categories\
186+
pandas.Series.cat.set_categories\
187+
pandas.Series.dt.ceil\
188+
pandas.Series.dt.day_name\
189+
pandas.Series.dt.floor\
190+
pandas.Series.dt.month_name\
191+
pandas.Series.dt.normalize\
192+
pandas.Series.dt.round\
193+
pandas.Series.dt.strftime\
194+
pandas.Series.dt.to_period\
195+
pandas.Series.dt.total_seconds\
196+
pandas.Series.dt.tz_convert\
197+
pandas.Series.dt.tz_localize\
198+
pandas.Series.get\
199+
pandas.Series.pad\
200+
pandas.Series.sem\
201+
pandas.Series.sparse\
202+
pandas.Series.std\
203+
pandas.Series.str\
204+
pandas.Series.str.wrap\
205+
pandas.Series.var\
206+
pandas.Timedelta.to_numpy\
207+
pandas.TimedeltaIndex\
208+
pandas.Timestamp.combine\
209+
pandas.Timestamp.fromtimestamp\
210+
pandas.Timestamp.strptime\
211+
pandas.Timestamp.to_numpy\
212+
pandas.Timestamp.to_period\
213+
pandas.Timestamp.to_pydatetime\
214+
pandas.Timestamp.utcfromtimestamp\
215+
pandas.api.extensions.ExtensionArray._pad_or_backfill\
216+
pandas.api.extensions.ExtensionArray.interpolate\
217+
pandas.api.indexers.BaseIndexer\
218+
pandas.api.indexers.FixedForwardWindowIndexer\
219+
pandas.api.indexers.VariableOffsetWindowIndexer\
220+
pandas.api.types.is_bool\
221+
pandas.api.types.is_complex\
222+
pandas.api.types.is_float\
223+
pandas.api.types.is_hashable\
224+
pandas.api.types.is_integer\
225+
pandas.core.groupby.DataFrameGroupBy.cummax\
226+
pandas.core.groupby.DataFrameGroupBy.cummin\
227+
pandas.core.groupby.DataFrameGroupBy.cumprod\
228+
pandas.core.groupby.DataFrameGroupBy.cumsum\
229+
pandas.core.groupby.DataFrameGroupBy.filter\
230+
pandas.core.groupby.DataFrameGroupBy.pct_change\
231+
pandas.core.groupby.DataFrameGroupBy.rolling\
232+
pandas.core.groupby.SeriesGroupBy.cummax\
233+
pandas.core.groupby.SeriesGroupBy.cummin\
234+
pandas.core.groupby.SeriesGroupBy.cumprod\
235+
pandas.core.groupby.SeriesGroupBy.cumsum\
236+
pandas.core.groupby.SeriesGroupBy.filter\
237+
pandas.core.groupby.SeriesGroupBy.nunique\
238+
pandas.core.groupby.SeriesGroupBy.pct_change\
239+
pandas.core.groupby.SeriesGroupBy.rolling\
240+
pandas.core.resample.Resampler.max\
241+
pandas.core.resample.Resampler.min\
242+
pandas.core.resample.Resampler.quantile\
243+
pandas.core.resample.Resampler.transform\
244+
pandas.core.window.expanding.Expanding.corr\
245+
pandas.core.window.expanding.Expanding.count\
246+
pandas.core.window.rolling.Rolling.max\
247+
pandas.core.window.rolling.Window.std\
248+
pandas.core.window.rolling.Window.var\
249+
pandas.errors.AbstractMethodError\
250+
pandas.errors.UndefinedVariableError\
251+
pandas.get_option\
252+
pandas.io.formats.style.Styler.to_excel\
253+
pandas.melt\
254+
pandas.option_context\
255+
pandas.read_fwf\
256+
pandas.reset_option\
257+
pandas.tseries.offsets.BQuarterBegin.is_month_end\
258+
pandas.tseries.offsets.BQuarterBegin.is_month_start\
259+
pandas.tseries.offsets.BQuarterBegin.is_quarter_end\
260+
pandas.tseries.offsets.BQuarterBegin.is_quarter_start\
261+
pandas.tseries.offsets.BQuarterBegin.is_year_end\
262+
pandas.tseries.offsets.BQuarterBegin.is_year_start\
263+
pandas.tseries.offsets.BQuarterEnd.is_month_end\
264+
pandas.tseries.offsets.BQuarterEnd.is_month_start\
265+
pandas.tseries.offsets.BQuarterEnd.is_quarter_end\
266+
pandas.tseries.offsets.BQuarterEnd.is_quarter_start\
267+
pandas.tseries.offsets.BQuarterEnd.is_year_end\
268+
pandas.tseries.offsets.BQuarterEnd.is_year_start\
269+
pandas.tseries.offsets.BYearBegin.is_month_end\
270+
pandas.tseries.offsets.BYearBegin.is_month_start\
271+
pandas.tseries.offsets.BYearBegin.is_quarter_end\
272+
pandas.tseries.offsets.BYearBegin.is_quarter_start\
273+
pandas.tseries.offsets.BYearBegin.is_year_end\
274+
pandas.tseries.offsets.BYearBegin.is_year_start\
275+
pandas.tseries.offsets.BYearEnd.is_month_end\
276+
pandas.tseries.offsets.BYearEnd.is_month_start\
277+
pandas.tseries.offsets.BYearEnd.is_quarter_end\
278+
pandas.tseries.offsets.BYearEnd.is_quarter_start\
279+
pandas.tseries.offsets.BYearEnd.is_year_end\
280+
pandas.tseries.offsets.BYearEnd.is_year_start\
281+
pandas.tseries.offsets.BusinessDay.is_month_end\
282+
pandas.tseries.offsets.BusinessDay.is_month_start\
283+
pandas.tseries.offsets.BusinessDay.is_quarter_end\
284+
pandas.tseries.offsets.BusinessDay.is_quarter_start\
285+
pandas.tseries.offsets.BusinessDay.is_year_end\
286+
pandas.tseries.offsets.BusinessDay.is_year_start\
287+
pandas.tseries.offsets.BusinessHour.is_month_end\
288+
pandas.tseries.offsets.BusinessHour.is_month_start\
289+
pandas.tseries.offsets.BusinessHour.is_quarter_end\
290+
pandas.tseries.offsets.BusinessHour.is_quarter_start\
291+
pandas.tseries.offsets.BusinessHour.is_year_end\
292+
pandas.tseries.offsets.BusinessHour.is_year_start\
293+
pandas.tseries.offsets.BusinessMonthBegin.is_month_end\
294+
pandas.tseries.offsets.BusinessMonthBegin.is_month_start\
295+
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_end\
296+
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_start\
297+
pandas.tseries.offsets.BusinessMonthBegin.is_year_end\
298+
pandas.tseries.offsets.BusinessMonthBegin.is_year_start\
299+
pandas.tseries.offsets.BusinessMonthEnd.is_month_end\
300+
pandas.tseries.offsets.BusinessMonthEnd.is_month_start\
301+
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_end\
302+
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_start\
303+
pandas.tseries.offsets.BusinessMonthEnd.is_year_end\
304+
pandas.tseries.offsets.BusinessMonthEnd.is_year_start\
305+
pandas.tseries.offsets.CustomBusinessDay.is_month_end\
306+
pandas.tseries.offsets.CustomBusinessDay.is_month_start\
307+
pandas.tseries.offsets.CustomBusinessDay.is_quarter_end\
308+
pandas.tseries.offsets.CustomBusinessDay.is_quarter_start\
309+
pandas.tseries.offsets.CustomBusinessDay.is_year_end\
310+
pandas.tseries.offsets.CustomBusinessDay.is_year_start\
311+
pandas.tseries.offsets.CustomBusinessHour.is_month_end\
312+
pandas.tseries.offsets.CustomBusinessHour.is_month_start\
313+
pandas.tseries.offsets.CustomBusinessHour.is_quarter_end\
314+
pandas.tseries.offsets.CustomBusinessHour.is_quarter_start\
315+
pandas.tseries.offsets.CustomBusinessHour.is_year_end\
316+
pandas.tseries.offsets.CustomBusinessHour.is_year_start\
317+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_end\
318+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_start\
319+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_end\
320+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_start\
321+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end\
322+
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_start\
323+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_end\
324+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_start\
325+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_end\
326+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_start\
327+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_end\
328+
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_start\
329+
pandas.tseries.offsets.DateOffset.is_month_end\
330+
pandas.tseries.offsets.DateOffset.is_month_start\
331+
pandas.tseries.offsets.DateOffset.is_quarter_end\
332+
pandas.tseries.offsets.DateOffset.is_quarter_start\
333+
pandas.tseries.offsets.DateOffset.is_year_end\
334+
pandas.tseries.offsets.DateOffset.is_year_start\
335+
pandas.tseries.offsets.Day.is_month_end\
336+
pandas.tseries.offsets.Day.is_month_start\
337+
pandas.tseries.offsets.Day.is_quarter_end\
338+
pandas.tseries.offsets.Day.is_quarter_start\
339+
pandas.tseries.offsets.Day.is_year_end\
340+
pandas.tseries.offsets.Day.is_year_start\
341+
pandas.tseries.offsets.Easter.is_month_end\
342+
pandas.tseries.offsets.Easter.is_month_start\
343+
pandas.tseries.offsets.Easter.is_quarter_end\
344+
pandas.tseries.offsets.Easter.is_quarter_start\
345+
pandas.tseries.offsets.Easter.is_year_end\
346+
pandas.tseries.offsets.Easter.is_year_start\
347+
pandas.tseries.offsets.FY5253.is_month_end\
348+
pandas.tseries.offsets.FY5253.is_month_start\
349+
pandas.tseries.offsets.FY5253.is_quarter_end\
350+
pandas.tseries.offsets.FY5253.is_quarter_start\
351+
pandas.tseries.offsets.FY5253.is_year_end\
352+
pandas.tseries.offsets.FY5253.is_year_start\
353+
pandas.tseries.offsets.FY5253Quarter.is_month_end\
354+
pandas.tseries.offsets.FY5253Quarter.is_month_start\
355+
pandas.tseries.offsets.FY5253Quarter.is_quarter_end\
356+
pandas.tseries.offsets.FY5253Quarter.is_quarter_start\
357+
pandas.tseries.offsets.FY5253Quarter.is_year_end\
358+
pandas.tseries.offsets.FY5253Quarter.is_year_start\
359+
pandas.tseries.offsets.Hour.is_month_end\
360+
pandas.tseries.offsets.Hour.is_month_start\
361+
pandas.tseries.offsets.Hour.is_quarter_end\
362+
pandas.tseries.offsets.Hour.is_quarter_start\
363+
pandas.tseries.offsets.Hour.is_year_end\
364+
pandas.tseries.offsets.Hour.is_year_start\
365+
pandas.tseries.offsets.LastWeekOfMonth.is_month_end\
366+
pandas.tseries.offsets.LastWeekOfMonth.is_month_start\
367+
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_end\
368+
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_start\
369+
pandas.tseries.offsets.LastWeekOfMonth.is_year_end\
370+
pandas.tseries.offsets.LastWeekOfMonth.is_year_start\
371+
pandas.tseries.offsets.Micro.is_month_end\
372+
pandas.tseries.offsets.Micro.is_month_start\
373+
pandas.tseries.offsets.Micro.is_quarter_end\
374+
pandas.tseries.offsets.Micro.is_quarter_start\
375+
pandas.tseries.offsets.Micro.is_year_end\
376+
pandas.tseries.offsets.Micro.is_year_start\
377+
pandas.tseries.offsets.Milli.is_month_end\
378+
pandas.tseries.offsets.Milli.is_month_start\
379+
pandas.tseries.offsets.Milli.is_quarter_end\
380+
pandas.tseries.offsets.Milli.is_quarter_start\
381+
pandas.tseries.offsets.Milli.is_year_end\
382+
pandas.tseries.offsets.Milli.is_year_start\
383+
pandas.tseries.offsets.Minute.is_month_end\
384+
pandas.tseries.offsets.Minute.is_month_start\
385+
pandas.tseries.offsets.Minute.is_quarter_end\
386+
pandas.tseries.offsets.Minute.is_quarter_start\
387+
pandas.tseries.offsets.Minute.is_year_end\
388+
pandas.tseries.offsets.Minute.is_year_start\
389+
pandas.tseries.offsets.MonthBegin.is_month_end\
390+
pandas.tseries.offsets.MonthBegin.is_month_start\
391+
pandas.tseries.offsets.MonthBegin.is_quarter_end\
392+
pandas.tseries.offsets.MonthBegin.is_quarter_start\
393+
pandas.tseries.offsets.MonthBegin.is_year_end\
394+
pandas.tseries.offsets.MonthBegin.is_year_start\
395+
pandas.tseries.offsets.MonthEnd.is_month_end\
396+
pandas.tseries.offsets.MonthEnd.is_month_start\
397+
pandas.tseries.offsets.MonthEnd.is_quarter_end\
398+
pandas.tseries.offsets.MonthEnd.is_quarter_start\
399+
pandas.tseries.offsets.MonthEnd.is_year_end\
400+
pandas.tseries.offsets.MonthEnd.is_year_start\
401+
pandas.tseries.offsets.Nano.is_month_end\
402+
pandas.tseries.offsets.Nano.is_month_start\
403+
pandas.tseries.offsets.Nano.is_quarter_end\
404+
pandas.tseries.offsets.Nano.is_quarter_start\
405+
pandas.tseries.offsets.Nano.is_year_end\
406+
pandas.tseries.offsets.Nano.is_year_start\
407+
pandas.tseries.offsets.QuarterBegin.is_month_end\
408+
pandas.tseries.offsets.QuarterBegin.is_month_start\
409+
pandas.tseries.offsets.QuarterBegin.is_quarter_end\
410+
pandas.tseries.offsets.QuarterBegin.is_quarter_start\
411+
pandas.tseries.offsets.QuarterBegin.is_year_end\
412+
pandas.tseries.offsets.QuarterBegin.is_year_start\
413+
pandas.tseries.offsets.QuarterEnd.is_month_end\
414+
pandas.tseries.offsets.QuarterEnd.is_month_start\
415+
pandas.tseries.offsets.QuarterEnd.is_quarter_end\
416+
pandas.tseries.offsets.QuarterEnd.is_quarter_start\
417+
pandas.tseries.offsets.QuarterEnd.is_year_end\
418+
pandas.tseries.offsets.QuarterEnd.is_year_start\
419+
pandas.tseries.offsets.Second.is_month_end\
420+
pandas.tseries.offsets.Second.is_month_start\
421+
pandas.tseries.offsets.Second.is_quarter_end\
422+
pandas.tseries.offsets.Second.is_quarter_start\
423+
pandas.tseries.offsets.Second.is_year_end\
424+
pandas.tseries.offsets.Second.is_year_start\
425+
pandas.tseries.offsets.SemiMonthBegin.is_month_end\
426+
pandas.tseries.offsets.SemiMonthBegin.is_month_start\
427+
pandas.tseries.offsets.SemiMonthBegin.is_quarter_end\
428+
pandas.tseries.offsets.SemiMonthBegin.is_quarter_start\
429+
pandas.tseries.offsets.SemiMonthBegin.is_year_end\
430+
pandas.tseries.offsets.SemiMonthBegin.is_year_start\
431+
pandas.tseries.offsets.SemiMonthEnd.is_month_end\
432+
pandas.tseries.offsets.SemiMonthEnd.is_month_start\
433+
pandas.tseries.offsets.SemiMonthEnd.is_quarter_end\
434+
pandas.tseries.offsets.SemiMonthEnd.is_quarter_start\
435+
pandas.tseries.offsets.SemiMonthEnd.is_year_end\
436+
pandas.tseries.offsets.SemiMonthEnd.is_year_start\
437+
pandas.tseries.offsets.Tick.is_month_end\
438+
pandas.tseries.offsets.Tick.is_month_start\
439+
pandas.tseries.offsets.Tick.is_quarter_end\
440+
pandas.tseries.offsets.Tick.is_quarter_start\
441+
pandas.tseries.offsets.Tick.is_year_end\
442+
pandas.tseries.offsets.Tick.is_year_start\
443+
pandas.tseries.offsets.Week.is_month_end\
444+
pandas.tseries.offsets.Week.is_month_start\
445+
pandas.tseries.offsets.Week.is_quarter_end\
446+
pandas.tseries.offsets.Week.is_quarter_start\
447+
pandas.tseries.offsets.Week.is_year_end\
448+
pandas.tseries.offsets.Week.is_year_start\
449+
pandas.tseries.offsets.WeekOfMonth.is_month_end\
450+
pandas.tseries.offsets.WeekOfMonth.is_month_start\
451+
pandas.tseries.offsets.WeekOfMonth.is_quarter_end\
452+
pandas.tseries.offsets.WeekOfMonth.is_quarter_start\
453+
pandas.tseries.offsets.WeekOfMonth.is_year_end\
454+
pandas.tseries.offsets.WeekOfMonth.is_year_start\
455+
pandas.tseries.offsets.YearBegin.is_month_end\
456+
pandas.tseries.offsets.YearBegin.is_month_start\
457+
pandas.tseries.offsets.YearBegin.is_quarter_end\
458+
pandas.tseries.offsets.YearBegin.is_quarter_start\
459+
pandas.tseries.offsets.YearBegin.is_year_end\
460+
pandas.tseries.offsets.YearBegin.is_year_start\
461+
pandas.tseries.offsets.YearEnd.is_month_end\
462+
pandas.tseries.offsets.YearEnd.is_month_start\
463+
pandas.tseries.offsets.YearEnd.is_quarter_end\
464+
pandas.tseries.offsets.YearEnd.is_quarter_start\
465+
pandas.tseries.offsets.YearEnd.is_year_end\
466+
pandas.tseries.offsets.YearEnd.is_year_start # There should be no backslash in the final line, please keep this comment in the last ignored function
467+
RET=$(($RET + $?)) ; echo $MSG "DONE"
468+
144469
MSG='Partially validate docstrings (PR07)' ; echo $MSG
145470
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
146471
pandas.DataFrame.align\

0 commit comments

Comments
 (0)