Skip to content

Commit 92a52e2

Browse files
CI/DOC: Enforce GL08 in CI (#57360)
Enforce GL08 in CI
1 parent db54438 commit 92a52e2

File tree

1 file changed

+273
-0
lines changed

1 file changed

+273
-0
lines changed

Diff for: ci/code_checks.sh

+273
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,279 @@ 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 (GL08)' ; echo $MSG
145+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL08 --ignore_functions \
146+
pandas.DatetimeIndex.as_unit\
147+
pandas.DatetimeIndex.freq\
148+
pandas.ExcelFile.book\
149+
pandas.ExcelFile.sheet_names\
150+
pandas.Index.empty\
151+
pandas.Index.names\
152+
pandas.Index.view\
153+
pandas.IntervalIndex.left\
154+
pandas.IntervalIndex.length\
155+
pandas.IntervalIndex.mid\
156+
pandas.IntervalIndex.right\
157+
pandas.MultiIndex.codes\
158+
pandas.Period.freq\
159+
pandas.Period.ordinal\
160+
pandas.PeriodIndex.freq\
161+
pandas.PeriodIndex.qyear\
162+
pandas.Series.dt\
163+
pandas.Series.dt.as_unit\
164+
pandas.Series.dt.freq\
165+
pandas.Series.dt.qyear\
166+
pandas.Series.dt.unit\
167+
pandas.Series.empty\
168+
pandas.Timedelta.microseconds\
169+
pandas.Timedelta.unit\
170+
pandas.Timedelta.value\
171+
pandas.Timestamp.day\
172+
pandas.Timestamp.fold\
173+
pandas.Timestamp.hour\
174+
pandas.Timestamp.microsecond\
175+
pandas.Timestamp.minute\
176+
pandas.Timestamp.month\
177+
pandas.Timestamp.nanosecond\
178+
pandas.Timestamp.second\
179+
pandas.Timestamp.tzinfo\
180+
pandas.Timestamp.value\
181+
pandas.Timestamp.year\
182+
pandas.core.groupby.SeriesGroupBy.value_counts\
183+
pandas.tseries.offsets.BQuarterBegin.is_anchored\
184+
pandas.tseries.offsets.BQuarterBegin.is_on_offset\
185+
pandas.tseries.offsets.BQuarterBegin.n\
186+
pandas.tseries.offsets.BQuarterBegin.nanos\
187+
pandas.tseries.offsets.BQuarterBegin.normalize\
188+
pandas.tseries.offsets.BQuarterBegin.rule_code\
189+
pandas.tseries.offsets.BQuarterBegin.startingMonth\
190+
pandas.tseries.offsets.BQuarterEnd.is_anchored\
191+
pandas.tseries.offsets.BQuarterEnd.is_on_offset\
192+
pandas.tseries.offsets.BQuarterEnd.n\
193+
pandas.tseries.offsets.BQuarterEnd.nanos\
194+
pandas.tseries.offsets.BQuarterEnd.normalize\
195+
pandas.tseries.offsets.BQuarterEnd.rule_code\
196+
pandas.tseries.offsets.BQuarterEnd.startingMonth\
197+
pandas.tseries.offsets.BYearBegin.is_on_offset\
198+
pandas.tseries.offsets.BYearBegin.month\
199+
pandas.tseries.offsets.BYearBegin.n\
200+
pandas.tseries.offsets.BYearBegin.nanos\
201+
pandas.tseries.offsets.BYearBegin.normalize\
202+
pandas.tseries.offsets.BYearBegin.rule_code\
203+
pandas.tseries.offsets.BYearEnd.is_on_offset\
204+
pandas.tseries.offsets.BYearEnd.month\
205+
pandas.tseries.offsets.BYearEnd.n\
206+
pandas.tseries.offsets.BYearEnd.nanos\
207+
pandas.tseries.offsets.BYearEnd.normalize\
208+
pandas.tseries.offsets.BYearEnd.rule_code\
209+
pandas.tseries.offsets.BusinessDay.calendar\
210+
pandas.tseries.offsets.BusinessDay.holidays\
211+
pandas.tseries.offsets.BusinessDay.is_on_offset\
212+
pandas.tseries.offsets.BusinessDay.n\
213+
pandas.tseries.offsets.BusinessDay.nanos\
214+
pandas.tseries.offsets.BusinessDay.normalize\
215+
pandas.tseries.offsets.BusinessDay.rule_code\
216+
pandas.tseries.offsets.BusinessDay.weekmask\
217+
pandas.tseries.offsets.BusinessHour.calendar\
218+
pandas.tseries.offsets.BusinessHour.end\
219+
pandas.tseries.offsets.BusinessHour.holidays\
220+
pandas.tseries.offsets.BusinessHour.is_on_offset\
221+
pandas.tseries.offsets.BusinessHour.n\
222+
pandas.tseries.offsets.BusinessHour.nanos\
223+
pandas.tseries.offsets.BusinessHour.normalize\
224+
pandas.tseries.offsets.BusinessHour.rule_code\
225+
pandas.tseries.offsets.BusinessHour.start\
226+
pandas.tseries.offsets.BusinessHour.weekmask\
227+
pandas.tseries.offsets.BusinessMonthBegin.is_on_offset\
228+
pandas.tseries.offsets.BusinessMonthBegin.n\
229+
pandas.tseries.offsets.BusinessMonthBegin.nanos\
230+
pandas.tseries.offsets.BusinessMonthBegin.normalize\
231+
pandas.tseries.offsets.BusinessMonthBegin.rule_code\
232+
pandas.tseries.offsets.BusinessMonthEnd.is_on_offset\
233+
pandas.tseries.offsets.BusinessMonthEnd.n\
234+
pandas.tseries.offsets.BusinessMonthEnd.nanos\
235+
pandas.tseries.offsets.BusinessMonthEnd.normalize\
236+
pandas.tseries.offsets.BusinessMonthEnd.rule_code\
237+
pandas.tseries.offsets.CustomBusinessDay.calendar\
238+
pandas.tseries.offsets.CustomBusinessDay.holidays\
239+
pandas.tseries.offsets.CustomBusinessDay.is_on_offset\
240+
pandas.tseries.offsets.CustomBusinessDay.n\
241+
pandas.tseries.offsets.CustomBusinessDay.nanos\
242+
pandas.tseries.offsets.CustomBusinessDay.normalize\
243+
pandas.tseries.offsets.CustomBusinessDay.rule_code\
244+
pandas.tseries.offsets.CustomBusinessDay.weekmask\
245+
pandas.tseries.offsets.CustomBusinessHour.calendar\
246+
pandas.tseries.offsets.CustomBusinessHour.end\
247+
pandas.tseries.offsets.CustomBusinessHour.holidays\
248+
pandas.tseries.offsets.CustomBusinessHour.is_on_offset\
249+
pandas.tseries.offsets.CustomBusinessHour.n\
250+
pandas.tseries.offsets.CustomBusinessHour.nanos\
251+
pandas.tseries.offsets.CustomBusinessHour.normalize\
252+
pandas.tseries.offsets.CustomBusinessHour.rule_code\
253+
pandas.tseries.offsets.CustomBusinessHour.start\
254+
pandas.tseries.offsets.CustomBusinessHour.weekmask\
255+
pandas.tseries.offsets.CustomBusinessMonthBegin.calendar\
256+
pandas.tseries.offsets.CustomBusinessMonthBegin.holidays\
257+
pandas.tseries.offsets.CustomBusinessMonthBegin.m_offset\
258+
pandas.tseries.offsets.CustomBusinessMonthBegin.n\
259+
pandas.tseries.offsets.CustomBusinessMonthBegin.nanos\
260+
pandas.tseries.offsets.CustomBusinessMonthBegin.normalize\
261+
pandas.tseries.offsets.CustomBusinessMonthBegin.rule_code\
262+
pandas.tseries.offsets.CustomBusinessMonthBegin.weekmask\
263+
pandas.tseries.offsets.CustomBusinessMonthEnd.calendar\
264+
pandas.tseries.offsets.CustomBusinessMonthEnd.holidays\
265+
pandas.tseries.offsets.CustomBusinessMonthEnd.m_offset\
266+
pandas.tseries.offsets.CustomBusinessMonthEnd.n\
267+
pandas.tseries.offsets.CustomBusinessMonthEnd.nanos\
268+
pandas.tseries.offsets.CustomBusinessMonthEnd.normalize\
269+
pandas.tseries.offsets.CustomBusinessMonthEnd.rule_code\
270+
pandas.tseries.offsets.CustomBusinessMonthEnd.weekmask\
271+
pandas.tseries.offsets.DateOffset.is_on_offset\
272+
pandas.tseries.offsets.DateOffset.n\
273+
pandas.tseries.offsets.DateOffset.nanos\
274+
pandas.tseries.offsets.DateOffset.normalize\
275+
pandas.tseries.offsets.DateOffset.rule_code\
276+
pandas.tseries.offsets.Day.delta\
277+
pandas.tseries.offsets.Day.is_on_offset\
278+
pandas.tseries.offsets.Day.n\
279+
pandas.tseries.offsets.Day.normalize\
280+
pandas.tseries.offsets.Day.rule_code\
281+
pandas.tseries.offsets.Easter.is_on_offset\
282+
pandas.tseries.offsets.Easter.n\
283+
pandas.tseries.offsets.Easter.nanos\
284+
pandas.tseries.offsets.Easter.normalize\
285+
pandas.tseries.offsets.Easter.rule_code\
286+
pandas.tseries.offsets.FY5253.get_rule_code_suffix\
287+
pandas.tseries.offsets.FY5253.get_year_end\
288+
pandas.tseries.offsets.FY5253.is_anchored\
289+
pandas.tseries.offsets.FY5253.is_on_offset\
290+
pandas.tseries.offsets.FY5253.n\
291+
pandas.tseries.offsets.FY5253.nanos\
292+
pandas.tseries.offsets.FY5253.normalize\
293+
pandas.tseries.offsets.FY5253.rule_code\
294+
pandas.tseries.offsets.FY5253.startingMonth\
295+
pandas.tseries.offsets.FY5253.variation\
296+
pandas.tseries.offsets.FY5253.weekday\
297+
pandas.tseries.offsets.FY5253Quarter.get_rule_code_suffix\
298+
pandas.tseries.offsets.FY5253Quarter.get_weeks\
299+
pandas.tseries.offsets.FY5253Quarter.is_anchored\
300+
pandas.tseries.offsets.FY5253Quarter.is_on_offset\
301+
pandas.tseries.offsets.FY5253Quarter.n\
302+
pandas.tseries.offsets.FY5253Quarter.nanos\
303+
pandas.tseries.offsets.FY5253Quarter.normalize\
304+
pandas.tseries.offsets.FY5253Quarter.qtr_with_extra_week\
305+
pandas.tseries.offsets.FY5253Quarter.rule_code\
306+
pandas.tseries.offsets.FY5253Quarter.startingMonth\
307+
pandas.tseries.offsets.FY5253Quarter.variation\
308+
pandas.tseries.offsets.FY5253Quarter.weekday\
309+
pandas.tseries.offsets.FY5253Quarter.year_has_extra_week\
310+
pandas.tseries.offsets.Hour.delta\
311+
pandas.tseries.offsets.Hour.is_on_offset\
312+
pandas.tseries.offsets.Hour.n\
313+
pandas.tseries.offsets.Hour.normalize\
314+
pandas.tseries.offsets.Hour.rule_code\
315+
pandas.tseries.offsets.LastWeekOfMonth.is_on_offset\
316+
pandas.tseries.offsets.LastWeekOfMonth.n\
317+
pandas.tseries.offsets.LastWeekOfMonth.nanos\
318+
pandas.tseries.offsets.LastWeekOfMonth.normalize\
319+
pandas.tseries.offsets.LastWeekOfMonth.rule_code\
320+
pandas.tseries.offsets.LastWeekOfMonth.week\
321+
pandas.tseries.offsets.LastWeekOfMonth.weekday\
322+
pandas.tseries.offsets.Micro.delta\
323+
pandas.tseries.offsets.Micro.is_on_offset\
324+
pandas.tseries.offsets.Micro.n\
325+
pandas.tseries.offsets.Micro.normalize\
326+
pandas.tseries.offsets.Micro.rule_code\
327+
pandas.tseries.offsets.Milli.delta\
328+
pandas.tseries.offsets.Milli.is_on_offset\
329+
pandas.tseries.offsets.Milli.n\
330+
pandas.tseries.offsets.Milli.normalize\
331+
pandas.tseries.offsets.Milli.rule_code\
332+
pandas.tseries.offsets.Minute.delta\
333+
pandas.tseries.offsets.Minute.is_on_offset\
334+
pandas.tseries.offsets.Minute.n\
335+
pandas.tseries.offsets.Minute.normalize\
336+
pandas.tseries.offsets.Minute.rule_code\
337+
pandas.tseries.offsets.MonthBegin.is_on_offset\
338+
pandas.tseries.offsets.MonthBegin.n\
339+
pandas.tseries.offsets.MonthBegin.nanos\
340+
pandas.tseries.offsets.MonthBegin.normalize\
341+
pandas.tseries.offsets.MonthBegin.rule_code\
342+
pandas.tseries.offsets.MonthEnd.is_on_offset\
343+
pandas.tseries.offsets.MonthEnd.n\
344+
pandas.tseries.offsets.MonthEnd.nanos\
345+
pandas.tseries.offsets.MonthEnd.normalize\
346+
pandas.tseries.offsets.MonthEnd.rule_code\
347+
pandas.tseries.offsets.Nano.delta\
348+
pandas.tseries.offsets.Nano.is_on_offset\
349+
pandas.tseries.offsets.Nano.n\
350+
pandas.tseries.offsets.Nano.normalize\
351+
pandas.tseries.offsets.Nano.rule_code\
352+
pandas.tseries.offsets.QuarterBegin.is_anchored\
353+
pandas.tseries.offsets.QuarterBegin.is_on_offset\
354+
pandas.tseries.offsets.QuarterBegin.n\
355+
pandas.tseries.offsets.QuarterBegin.nanos\
356+
pandas.tseries.offsets.QuarterBegin.normalize\
357+
pandas.tseries.offsets.QuarterBegin.rule_code\
358+
pandas.tseries.offsets.QuarterBegin.startingMonth\
359+
pandas.tseries.offsets.QuarterEnd.is_anchored\
360+
pandas.tseries.offsets.QuarterEnd.is_on_offset\
361+
pandas.tseries.offsets.QuarterEnd.n\
362+
pandas.tseries.offsets.QuarterEnd.nanos\
363+
pandas.tseries.offsets.QuarterEnd.normalize\
364+
pandas.tseries.offsets.QuarterEnd.rule_code\
365+
pandas.tseries.offsets.QuarterEnd.startingMonth\
366+
pandas.tseries.offsets.Second.delta\
367+
pandas.tseries.offsets.Second.is_on_offset\
368+
pandas.tseries.offsets.Second.n\
369+
pandas.tseries.offsets.Second.normalize\
370+
pandas.tseries.offsets.Second.rule_code\
371+
pandas.tseries.offsets.SemiMonthBegin.day_of_month\
372+
pandas.tseries.offsets.SemiMonthBegin.is_on_offset\
373+
pandas.tseries.offsets.SemiMonthBegin.n\
374+
pandas.tseries.offsets.SemiMonthBegin.nanos\
375+
pandas.tseries.offsets.SemiMonthBegin.normalize\
376+
pandas.tseries.offsets.SemiMonthBegin.rule_code\
377+
pandas.tseries.offsets.SemiMonthEnd.day_of_month\
378+
pandas.tseries.offsets.SemiMonthEnd.is_on_offset\
379+
pandas.tseries.offsets.SemiMonthEnd.n\
380+
pandas.tseries.offsets.SemiMonthEnd.nanos\
381+
pandas.tseries.offsets.SemiMonthEnd.normalize\
382+
pandas.tseries.offsets.SemiMonthEnd.rule_code\
383+
pandas.tseries.offsets.Tick\
384+
pandas.tseries.offsets.Tick.delta\
385+
pandas.tseries.offsets.Tick.is_on_offset\
386+
pandas.tseries.offsets.Tick.n\
387+
pandas.tseries.offsets.Tick.normalize\
388+
pandas.tseries.offsets.Tick.rule_code\
389+
pandas.tseries.offsets.Week.is_anchored\
390+
pandas.tseries.offsets.Week.is_on_offset\
391+
pandas.tseries.offsets.Week.n\
392+
pandas.tseries.offsets.Week.nanos\
393+
pandas.tseries.offsets.Week.normalize\
394+
pandas.tseries.offsets.Week.rule_code\
395+
pandas.tseries.offsets.Week.weekday\
396+
pandas.tseries.offsets.WeekOfMonth.is_on_offset\
397+
pandas.tseries.offsets.WeekOfMonth.n\
398+
pandas.tseries.offsets.WeekOfMonth.nanos\
399+
pandas.tseries.offsets.WeekOfMonth.normalize\
400+
pandas.tseries.offsets.WeekOfMonth.rule_code\
401+
pandas.tseries.offsets.WeekOfMonth.week\
402+
pandas.tseries.offsets.WeekOfMonth.weekday\
403+
pandas.tseries.offsets.YearBegin.is_on_offset\
404+
pandas.tseries.offsets.YearBegin.month\
405+
pandas.tseries.offsets.YearBegin.n\
406+
pandas.tseries.offsets.YearBegin.nanos\
407+
pandas.tseries.offsets.YearBegin.normalize\
408+
pandas.tseries.offsets.YearBegin.rule_code\
409+
pandas.tseries.offsets.YearEnd.is_on_offset\
410+
pandas.tseries.offsets.YearEnd.month\
411+
pandas.tseries.offsets.YearEnd.n\
412+
pandas.tseries.offsets.YearEnd.nanos\
413+
pandas.tseries.offsets.YearEnd.normalize\
414+
pandas.tseries.offsets.YearEnd.rule_code # There should be no backslash in the final line, please keep this comment in the last ignored function
415+
RET=$(($RET + $?)) ; echo $MSG "DONE"
416+
144417
MSG='Partially validate docstrings (ES01)' ; echo $MSG
145418
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=ES01 --ignore_functions \
146419
pandas.Categorical.__array__\

0 commit comments

Comments
 (0)