Skip to content

Commit

Permalink
CI/DOC: Enforce GL08 in CI (#57360)
Browse files Browse the repository at this point in the history 
Enforce GL08 in CI
  • Loading branch information
@jordan-d-murphy
jordan-d-murphy committed Feb 15, 2024
1 parent db54438 commit 92a52e2
Showing 1 changed file with 273 additions and 0 deletions.
273 changes: 273 additions & 0 deletions ci/code_checks.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,279 @@ 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 (GL08)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL08 --ignore_functions \
pandas.DatetimeIndex.as_unit\
pandas.DatetimeIndex.freq\
pandas.ExcelFile.book\
pandas.ExcelFile.sheet_names\
pandas.Index.empty\
pandas.Index.names\
pandas.Index.view\
pandas.IntervalIndex.left\
pandas.IntervalIndex.length\
pandas.IntervalIndex.mid\
pandas.IntervalIndex.right\
pandas.MultiIndex.codes\
pandas.Period.freq\
pandas.Period.ordinal\
pandas.PeriodIndex.freq\
pandas.PeriodIndex.qyear\
pandas.Series.dt\
pandas.Series.dt.as_unit\
pandas.Series.dt.freq\
pandas.Series.dt.qyear\
pandas.Series.dt.unit\
pandas.Series.empty\
pandas.Timedelta.microseconds\
pandas.Timedelta.unit\
pandas.Timedelta.value\
pandas.Timestamp.day\
pandas.Timestamp.fold\
pandas.Timestamp.hour\
pandas.Timestamp.microsecond\
pandas.Timestamp.minute\
pandas.Timestamp.month\
pandas.Timestamp.nanosecond\
pandas.Timestamp.second\
pandas.Timestamp.tzinfo\
pandas.Timestamp.value\
pandas.Timestamp.year\
pandas.core.groupby.SeriesGroupBy.value_counts\
pandas.tseries.offsets.BQuarterBegin.is_anchored\
pandas.tseries.offsets.BQuarterBegin.is_on_offset\
pandas.tseries.offsets.BQuarterBegin.n\
pandas.tseries.offsets.BQuarterBegin.nanos\
pandas.tseries.offsets.BQuarterBegin.normalize\
pandas.tseries.offsets.BQuarterBegin.rule_code\
pandas.tseries.offsets.BQuarterBegin.startingMonth\
pandas.tseries.offsets.BQuarterEnd.is_anchored\
pandas.tseries.offsets.BQuarterEnd.is_on_offset\
pandas.tseries.offsets.BQuarterEnd.n\
pandas.tseries.offsets.BQuarterEnd.nanos\
pandas.tseries.offsets.BQuarterEnd.normalize\
pandas.tseries.offsets.BQuarterEnd.rule_code\
pandas.tseries.offsets.BQuarterEnd.startingMonth\
pandas.tseries.offsets.BYearBegin.is_on_offset\
pandas.tseries.offsets.BYearBegin.month\
pandas.tseries.offsets.BYearBegin.n\
pandas.tseries.offsets.BYearBegin.nanos\
pandas.tseries.offsets.BYearBegin.normalize\
pandas.tseries.offsets.BYearBegin.rule_code\
pandas.tseries.offsets.BYearEnd.is_on_offset\
pandas.tseries.offsets.BYearEnd.month\
pandas.tseries.offsets.BYearEnd.n\
pandas.tseries.offsets.BYearEnd.nanos\
pandas.tseries.offsets.BYearEnd.normalize\
pandas.tseries.offsets.BYearEnd.rule_code\
pandas.tseries.offsets.BusinessDay.calendar\
pandas.tseries.offsets.BusinessDay.holidays\
pandas.tseries.offsets.BusinessDay.is_on_offset\
pandas.tseries.offsets.BusinessDay.n\
pandas.tseries.offsets.BusinessDay.nanos\
pandas.tseries.offsets.BusinessDay.normalize\
pandas.tseries.offsets.BusinessDay.rule_code\
pandas.tseries.offsets.BusinessDay.weekmask\
pandas.tseries.offsets.BusinessHour.calendar\
pandas.tseries.offsets.BusinessHour.end\
pandas.tseries.offsets.BusinessHour.holidays\
pandas.tseries.offsets.BusinessHour.is_on_offset\
pandas.tseries.offsets.BusinessHour.n\
pandas.tseries.offsets.BusinessHour.nanos\
pandas.tseries.offsets.BusinessHour.normalize\
pandas.tseries.offsets.BusinessHour.rule_code\
pandas.tseries.offsets.BusinessHour.start\
pandas.tseries.offsets.BusinessHour.weekmask\
pandas.tseries.offsets.BusinessMonthBegin.is_on_offset\
pandas.tseries.offsets.BusinessMonthBegin.n\
pandas.tseries.offsets.BusinessMonthBegin.nanos\
pandas.tseries.offsets.BusinessMonthBegin.normalize\
pandas.tseries.offsets.BusinessMonthBegin.rule_code\
pandas.tseries.offsets.BusinessMonthEnd.is_on_offset\
pandas.tseries.offsets.BusinessMonthEnd.n\
pandas.tseries.offsets.BusinessMonthEnd.nanos\
pandas.tseries.offsets.BusinessMonthEnd.normalize\
pandas.tseries.offsets.BusinessMonthEnd.rule_code\
pandas.tseries.offsets.CustomBusinessDay.calendar\
pandas.tseries.offsets.CustomBusinessDay.holidays\
pandas.tseries.offsets.CustomBusinessDay.is_on_offset\
pandas.tseries.offsets.CustomBusinessDay.n\
pandas.tseries.offsets.CustomBusinessDay.nanos\
pandas.tseries.offsets.CustomBusinessDay.normalize\
pandas.tseries.offsets.CustomBusinessDay.rule_code\
pandas.tseries.offsets.CustomBusinessDay.weekmask\
pandas.tseries.offsets.CustomBusinessHour.calendar\
pandas.tseries.offsets.CustomBusinessHour.end\
pandas.tseries.offsets.CustomBusinessHour.holidays\
pandas.tseries.offsets.CustomBusinessHour.is_on_offset\
pandas.tseries.offsets.CustomBusinessHour.n\
pandas.tseries.offsets.CustomBusinessHour.nanos\
pandas.tseries.offsets.CustomBusinessHour.normalize\
pandas.tseries.offsets.CustomBusinessHour.rule_code\
pandas.tseries.offsets.CustomBusinessHour.start\
pandas.tseries.offsets.CustomBusinessHour.weekmask\
pandas.tseries.offsets.CustomBusinessMonthBegin.calendar\
pandas.tseries.offsets.CustomBusinessMonthBegin.holidays\
pandas.tseries.offsets.CustomBusinessMonthBegin.m_offset\
pandas.tseries.offsets.CustomBusinessMonthBegin.n\
pandas.tseries.offsets.CustomBusinessMonthBegin.nanos\
pandas.tseries.offsets.CustomBusinessMonthBegin.normalize\
pandas.tseries.offsets.CustomBusinessMonthBegin.rule_code\
pandas.tseries.offsets.CustomBusinessMonthBegin.weekmask\
pandas.tseries.offsets.CustomBusinessMonthEnd.calendar\
pandas.tseries.offsets.CustomBusinessMonthEnd.holidays\
pandas.tseries.offsets.CustomBusinessMonthEnd.m_offset\
pandas.tseries.offsets.CustomBusinessMonthEnd.n\
pandas.tseries.offsets.CustomBusinessMonthEnd.nanos\
pandas.tseries.offsets.CustomBusinessMonthEnd.normalize\
pandas.tseries.offsets.CustomBusinessMonthEnd.rule_code\
pandas.tseries.offsets.CustomBusinessMonthEnd.weekmask\
pandas.tseries.offsets.DateOffset.is_on_offset\
pandas.tseries.offsets.DateOffset.n\
pandas.tseries.offsets.DateOffset.nanos\
pandas.tseries.offsets.DateOffset.normalize\
pandas.tseries.offsets.DateOffset.rule_code\
pandas.tseries.offsets.Day.delta\
pandas.tseries.offsets.Day.is_on_offset\
pandas.tseries.offsets.Day.n\
pandas.tseries.offsets.Day.normalize\
pandas.tseries.offsets.Day.rule_code\
pandas.tseries.offsets.Easter.is_on_offset\
pandas.tseries.offsets.Easter.n\
pandas.tseries.offsets.Easter.nanos\
pandas.tseries.offsets.Easter.normalize\
pandas.tseries.offsets.Easter.rule_code\
pandas.tseries.offsets.FY5253.get_rule_code_suffix\
pandas.tseries.offsets.FY5253.get_year_end\
pandas.tseries.offsets.FY5253.is_anchored\
pandas.tseries.offsets.FY5253.is_on_offset\
pandas.tseries.offsets.FY5253.n\
pandas.tseries.offsets.FY5253.nanos\
pandas.tseries.offsets.FY5253.normalize\
pandas.tseries.offsets.FY5253.rule_code\
pandas.tseries.offsets.FY5253.startingMonth\
pandas.tseries.offsets.FY5253.variation\
pandas.tseries.offsets.FY5253.weekday\
pandas.tseries.offsets.FY5253Quarter.get_rule_code_suffix\
pandas.tseries.offsets.FY5253Quarter.get_weeks\
pandas.tseries.offsets.FY5253Quarter.is_anchored\
pandas.tseries.offsets.FY5253Quarter.is_on_offset\
pandas.tseries.offsets.FY5253Quarter.n\
pandas.tseries.offsets.FY5253Quarter.nanos\
pandas.tseries.offsets.FY5253Quarter.normalize\
pandas.tseries.offsets.FY5253Quarter.qtr_with_extra_week\
pandas.tseries.offsets.FY5253Quarter.rule_code\
pandas.tseries.offsets.FY5253Quarter.startingMonth\
pandas.tseries.offsets.FY5253Quarter.variation\
pandas.tseries.offsets.FY5253Quarter.weekday\
pandas.tseries.offsets.FY5253Quarter.year_has_extra_week\
pandas.tseries.offsets.Hour.delta\
pandas.tseries.offsets.Hour.is_on_offset\
pandas.tseries.offsets.Hour.n\
pandas.tseries.offsets.Hour.normalize\
pandas.tseries.offsets.Hour.rule_code\
pandas.tseries.offsets.LastWeekOfMonth.is_on_offset\
pandas.tseries.offsets.LastWeekOfMonth.n\
pandas.tseries.offsets.LastWeekOfMonth.nanos\
pandas.tseries.offsets.LastWeekOfMonth.normalize\
pandas.tseries.offsets.LastWeekOfMonth.rule_code\
pandas.tseries.offsets.LastWeekOfMonth.week\
pandas.tseries.offsets.LastWeekOfMonth.weekday\
pandas.tseries.offsets.Micro.delta\
pandas.tseries.offsets.Micro.is_on_offset\
pandas.tseries.offsets.Micro.n\
pandas.tseries.offsets.Micro.normalize\
pandas.tseries.offsets.Micro.rule_code\
pandas.tseries.offsets.Milli.delta\
pandas.tseries.offsets.Milli.is_on_offset\
pandas.tseries.offsets.Milli.n\
pandas.tseries.offsets.Milli.normalize\
pandas.tseries.offsets.Milli.rule_code\
pandas.tseries.offsets.Minute.delta\
pandas.tseries.offsets.Minute.is_on_offset\
pandas.tseries.offsets.Minute.n\
pandas.tseries.offsets.Minute.normalize\
pandas.tseries.offsets.Minute.rule_code\
pandas.tseries.offsets.MonthBegin.is_on_offset\
pandas.tseries.offsets.MonthBegin.n\
pandas.tseries.offsets.MonthBegin.nanos\
pandas.tseries.offsets.MonthBegin.normalize\
pandas.tseries.offsets.MonthBegin.rule_code\
pandas.tseries.offsets.MonthEnd.is_on_offset\
pandas.tseries.offsets.MonthEnd.n\
pandas.tseries.offsets.MonthEnd.nanos\
pandas.tseries.offsets.MonthEnd.normalize\
pandas.tseries.offsets.MonthEnd.rule_code\
pandas.tseries.offsets.Nano.delta\
pandas.tseries.offsets.Nano.is_on_offset\
pandas.tseries.offsets.Nano.n\
pandas.tseries.offsets.Nano.normalize\
pandas.tseries.offsets.Nano.rule_code\
pandas.tseries.offsets.QuarterBegin.is_anchored\
pandas.tseries.offsets.QuarterBegin.is_on_offset\
pandas.tseries.offsets.QuarterBegin.n\
pandas.tseries.offsets.QuarterBegin.nanos\
pandas.tseries.offsets.QuarterBegin.normalize\
pandas.tseries.offsets.QuarterBegin.rule_code\
pandas.tseries.offsets.QuarterBegin.startingMonth\
pandas.tseries.offsets.QuarterEnd.is_anchored\
pandas.tseries.offsets.QuarterEnd.is_on_offset\
pandas.tseries.offsets.QuarterEnd.n\
pandas.tseries.offsets.QuarterEnd.nanos\
pandas.tseries.offsets.QuarterEnd.normalize\
pandas.tseries.offsets.QuarterEnd.rule_code\
pandas.tseries.offsets.QuarterEnd.startingMonth\
pandas.tseries.offsets.Second.delta\
pandas.tseries.offsets.Second.is_on_offset\
pandas.tseries.offsets.Second.n\
pandas.tseries.offsets.Second.normalize\
pandas.tseries.offsets.Second.rule_code\
pandas.tseries.offsets.SemiMonthBegin.day_of_month\
pandas.tseries.offsets.SemiMonthBegin.is_on_offset\
pandas.tseries.offsets.SemiMonthBegin.n\
pandas.tseries.offsets.SemiMonthBegin.nanos\
pandas.tseries.offsets.SemiMonthBegin.normalize\
pandas.tseries.offsets.SemiMonthBegin.rule_code\
pandas.tseries.offsets.SemiMonthEnd.day_of_month\
pandas.tseries.offsets.SemiMonthEnd.is_on_offset\
pandas.tseries.offsets.SemiMonthEnd.n\
pandas.tseries.offsets.SemiMonthEnd.nanos\
pandas.tseries.offsets.SemiMonthEnd.normalize\
pandas.tseries.offsets.SemiMonthEnd.rule_code\
pandas.tseries.offsets.Tick\
pandas.tseries.offsets.Tick.delta\
pandas.tseries.offsets.Tick.is_on_offset\
pandas.tseries.offsets.Tick.n\
pandas.tseries.offsets.Tick.normalize\
pandas.tseries.offsets.Tick.rule_code\
pandas.tseries.offsets.Week.is_anchored\
pandas.tseries.offsets.Week.is_on_offset\
pandas.tseries.offsets.Week.n\
pandas.tseries.offsets.Week.nanos\
pandas.tseries.offsets.Week.normalize\
pandas.tseries.offsets.Week.rule_code\
pandas.tseries.offsets.Week.weekday\
pandas.tseries.offsets.WeekOfMonth.is_on_offset\
pandas.tseries.offsets.WeekOfMonth.n\
pandas.tseries.offsets.WeekOfMonth.nanos\
pandas.tseries.offsets.WeekOfMonth.normalize\
pandas.tseries.offsets.WeekOfMonth.rule_code\
pandas.tseries.offsets.WeekOfMonth.week\
pandas.tseries.offsets.WeekOfMonth.weekday\
pandas.tseries.offsets.YearBegin.is_on_offset\
pandas.tseries.offsets.YearBegin.month\
pandas.tseries.offsets.YearBegin.n\
pandas.tseries.offsets.YearBegin.nanos\
pandas.tseries.offsets.YearBegin.normalize\
pandas.tseries.offsets.YearBegin.rule_code\
pandas.tseries.offsets.YearEnd.is_on_offset\
pandas.tseries.offsets.YearEnd.month\
pandas.tseries.offsets.YearEnd.n\
pandas.tseries.offsets.YearEnd.nanos\
pandas.tseries.offsets.YearEnd.normalize\
pandas.tseries.offsets.YearEnd.rule_code # 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 (ES01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=ES01 --ignore_functions \
pandas.Categorical.__array__\
Expand Down

0 comments on commit 92a52e2

Please sign in to comment.