Skip to content

Commit

Permalink
CI/DOC: Enforce PR01 in CI (#57358)
Browse files Browse the repository at this point in the history 
Enforce PR01 in CI
  • Loading branch information
@jordan-d-murphy
jordan-d-murphy committed Feb 14, 2024
1 parent c437277 commit 1ed627a
Showing 1 changed file with 325 additions and 0 deletions.
325 changes: 325 additions & 0 deletions ci/code_checks.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,331 @@ 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 (PR01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR01 --ignore_functions \
pandas.Categorical\
pandas.Categorical.__array__\
pandas.CategoricalIndex.equals\
pandas.CategoricalIndex.map\
pandas.DataFrame.at_time\
pandas.DataFrame.backfill\
pandas.DataFrame.get\
pandas.DataFrame.pad\
pandas.DataFrame.sem\
pandas.DataFrame.sparse\
pandas.DataFrame.std\
pandas.DataFrame.swapaxes\
pandas.DataFrame.var\
pandas.DatetimeIndex.indexer_at_time\
pandas.DatetimeIndex.snap\
pandas.DatetimeIndex.std\
pandas.ExcelFile\
pandas.ExcelFile.parse\
pandas.Grouper\
pandas.HDFStore.append\
pandas.HDFStore.put\
pandas.Index.get_indexer_for\
pandas.Index.identical\
pandas.Index.putmask\
pandas.Index.ravel\
pandas.Index.str\
pandas.Index.take\
pandas.IntervalDtype\
pandas.MultiIndex\
pandas.Period.strftime\
pandas.RangeIndex.from_range\
pandas.Series.at_time\
pandas.Series.backfill\
pandas.Series.cat.add_categories\
pandas.Series.cat.as_ordered\
pandas.Series.cat.as_unordered\
pandas.Series.cat.remove_categories\
pandas.Series.cat.remove_unused_categories\
pandas.Series.cat.rename_categories\
pandas.Series.cat.reorder_categories\
pandas.Series.cat.set_categories\
pandas.Series.dt.ceil\
pandas.Series.dt.day_name\
pandas.Series.dt.floor\
pandas.Series.dt.month_name\
pandas.Series.dt.normalize\
pandas.Series.dt.round\
pandas.Series.dt.strftime\
pandas.Series.dt.to_period\
pandas.Series.dt.total_seconds\
pandas.Series.dt.tz_convert\
pandas.Series.dt.tz_localize\
pandas.Series.get\
pandas.Series.pad\
pandas.Series.sem\
pandas.Series.sparse\
pandas.Series.std\
pandas.Series.str\
pandas.Series.str.wrap\
pandas.Series.var\
pandas.Timedelta.to_numpy\
pandas.TimedeltaIndex\
pandas.Timestamp.combine\
pandas.Timestamp.fromtimestamp\
pandas.Timestamp.strptime\
pandas.Timestamp.to_numpy\
pandas.Timestamp.to_period\
pandas.Timestamp.to_pydatetime\
pandas.Timestamp.utcfromtimestamp\
pandas.api.extensions.ExtensionArray._pad_or_backfill\
pandas.api.extensions.ExtensionArray.interpolate\
pandas.api.indexers.BaseIndexer\
pandas.api.indexers.FixedForwardWindowIndexer\
pandas.api.indexers.VariableOffsetWindowIndexer\
pandas.api.types.is_bool\
pandas.api.types.is_complex\
pandas.api.types.is_float\
pandas.api.types.is_hashable\
pandas.api.types.is_integer\
pandas.core.groupby.DataFrameGroupBy.cummax\
pandas.core.groupby.DataFrameGroupBy.cummin\
pandas.core.groupby.DataFrameGroupBy.cumprod\
pandas.core.groupby.DataFrameGroupBy.cumsum\
pandas.core.groupby.DataFrameGroupBy.filter\
pandas.core.groupby.DataFrameGroupBy.pct_change\
pandas.core.groupby.DataFrameGroupBy.rolling\
pandas.core.groupby.SeriesGroupBy.cummax\
pandas.core.groupby.SeriesGroupBy.cummin\
pandas.core.groupby.SeriesGroupBy.cumprod\
pandas.core.groupby.SeriesGroupBy.cumsum\
pandas.core.groupby.SeriesGroupBy.filter\
pandas.core.groupby.SeriesGroupBy.nunique\
pandas.core.groupby.SeriesGroupBy.pct_change\
pandas.core.groupby.SeriesGroupBy.rolling\
pandas.core.resample.Resampler.max\
pandas.core.resample.Resampler.min\
pandas.core.resample.Resampler.quantile\
pandas.core.resample.Resampler.transform\
pandas.core.window.expanding.Expanding.corr\
pandas.core.window.expanding.Expanding.count\
pandas.core.window.rolling.Rolling.max\
pandas.core.window.rolling.Window.std\
pandas.core.window.rolling.Window.var\
pandas.errors.AbstractMethodError\
pandas.errors.UndefinedVariableError\
pandas.get_option\
pandas.io.formats.style.Styler.to_excel\
pandas.melt\
pandas.option_context\
pandas.read_fwf\
pandas.reset_option\
pandas.tseries.offsets.BQuarterBegin.is_month_end\
pandas.tseries.offsets.BQuarterBegin.is_month_start\
pandas.tseries.offsets.BQuarterBegin.is_quarter_end\
pandas.tseries.offsets.BQuarterBegin.is_quarter_start\
pandas.tseries.offsets.BQuarterBegin.is_year_end\
pandas.tseries.offsets.BQuarterBegin.is_year_start\
pandas.tseries.offsets.BQuarterEnd.is_month_end\
pandas.tseries.offsets.BQuarterEnd.is_month_start\
pandas.tseries.offsets.BQuarterEnd.is_quarter_end\
pandas.tseries.offsets.BQuarterEnd.is_quarter_start\
pandas.tseries.offsets.BQuarterEnd.is_year_end\
pandas.tseries.offsets.BQuarterEnd.is_year_start\
pandas.tseries.offsets.BYearBegin.is_month_end\
pandas.tseries.offsets.BYearBegin.is_month_start\
pandas.tseries.offsets.BYearBegin.is_quarter_end\
pandas.tseries.offsets.BYearBegin.is_quarter_start\
pandas.tseries.offsets.BYearBegin.is_year_end\
pandas.tseries.offsets.BYearBegin.is_year_start\
pandas.tseries.offsets.BYearEnd.is_month_end\
pandas.tseries.offsets.BYearEnd.is_month_start\
pandas.tseries.offsets.BYearEnd.is_quarter_end\
pandas.tseries.offsets.BYearEnd.is_quarter_start\
pandas.tseries.offsets.BYearEnd.is_year_end\
pandas.tseries.offsets.BYearEnd.is_year_start\
pandas.tseries.offsets.BusinessDay.is_month_end\
pandas.tseries.offsets.BusinessDay.is_month_start\
pandas.tseries.offsets.BusinessDay.is_quarter_end\
pandas.tseries.offsets.BusinessDay.is_quarter_start\
pandas.tseries.offsets.BusinessDay.is_year_end\
pandas.tseries.offsets.BusinessDay.is_year_start\
pandas.tseries.offsets.BusinessHour.is_month_end\
pandas.tseries.offsets.BusinessHour.is_month_start\
pandas.tseries.offsets.BusinessHour.is_quarter_end\
pandas.tseries.offsets.BusinessHour.is_quarter_start\
pandas.tseries.offsets.BusinessHour.is_year_end\
pandas.tseries.offsets.BusinessHour.is_year_start\
pandas.tseries.offsets.BusinessMonthBegin.is_month_end\
pandas.tseries.offsets.BusinessMonthBegin.is_month_start\
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_end\
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_start\
pandas.tseries.offsets.BusinessMonthBegin.is_year_end\
pandas.tseries.offsets.BusinessMonthBegin.is_year_start\
pandas.tseries.offsets.BusinessMonthEnd.is_month_end\
pandas.tseries.offsets.BusinessMonthEnd.is_month_start\
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_end\
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_start\
pandas.tseries.offsets.BusinessMonthEnd.is_year_end\
pandas.tseries.offsets.BusinessMonthEnd.is_year_start\
pandas.tseries.offsets.CustomBusinessDay.is_month_end\
pandas.tseries.offsets.CustomBusinessDay.is_month_start\
pandas.tseries.offsets.CustomBusinessDay.is_quarter_end\
pandas.tseries.offsets.CustomBusinessDay.is_quarter_start\
pandas.tseries.offsets.CustomBusinessDay.is_year_end\
pandas.tseries.offsets.CustomBusinessDay.is_year_start\
pandas.tseries.offsets.CustomBusinessHour.is_month_end\
pandas.tseries.offsets.CustomBusinessHour.is_month_start\
pandas.tseries.offsets.CustomBusinessHour.is_quarter_end\
pandas.tseries.offsets.CustomBusinessHour.is_quarter_start\
pandas.tseries.offsets.CustomBusinessHour.is_year_end\
pandas.tseries.offsets.CustomBusinessHour.is_year_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_start\
pandas.tseries.offsets.DateOffset.is_month_end\
pandas.tseries.offsets.DateOffset.is_month_start\
pandas.tseries.offsets.DateOffset.is_quarter_end\
pandas.tseries.offsets.DateOffset.is_quarter_start\
pandas.tseries.offsets.DateOffset.is_year_end\
pandas.tseries.offsets.DateOffset.is_year_start\
pandas.tseries.offsets.Day.is_month_end\
pandas.tseries.offsets.Day.is_month_start\
pandas.tseries.offsets.Day.is_quarter_end\
pandas.tseries.offsets.Day.is_quarter_start\
pandas.tseries.offsets.Day.is_year_end\
pandas.tseries.offsets.Day.is_year_start\
pandas.tseries.offsets.Easter.is_month_end\
pandas.tseries.offsets.Easter.is_month_start\
pandas.tseries.offsets.Easter.is_quarter_end\
pandas.tseries.offsets.Easter.is_quarter_start\
pandas.tseries.offsets.Easter.is_year_end\
pandas.tseries.offsets.Easter.is_year_start\
pandas.tseries.offsets.FY5253.is_month_end\
pandas.tseries.offsets.FY5253.is_month_start\
pandas.tseries.offsets.FY5253.is_quarter_end\
pandas.tseries.offsets.FY5253.is_quarter_start\
pandas.tseries.offsets.FY5253.is_year_end\
pandas.tseries.offsets.FY5253.is_year_start\
pandas.tseries.offsets.FY5253Quarter.is_month_end\
pandas.tseries.offsets.FY5253Quarter.is_month_start\
pandas.tseries.offsets.FY5253Quarter.is_quarter_end\
pandas.tseries.offsets.FY5253Quarter.is_quarter_start\
pandas.tseries.offsets.FY5253Quarter.is_year_end\
pandas.tseries.offsets.FY5253Quarter.is_year_start\
pandas.tseries.offsets.Hour.is_month_end\
pandas.tseries.offsets.Hour.is_month_start\
pandas.tseries.offsets.Hour.is_quarter_end\
pandas.tseries.offsets.Hour.is_quarter_start\
pandas.tseries.offsets.Hour.is_year_end\
pandas.tseries.offsets.Hour.is_year_start\
pandas.tseries.offsets.LastWeekOfMonth.is_month_end\
pandas.tseries.offsets.LastWeekOfMonth.is_month_start\
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_end\
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_start\
pandas.tseries.offsets.LastWeekOfMonth.is_year_end\
pandas.tseries.offsets.LastWeekOfMonth.is_year_start\
pandas.tseries.offsets.Micro.is_month_end\
pandas.tseries.offsets.Micro.is_month_start\
pandas.tseries.offsets.Micro.is_quarter_end\
pandas.tseries.offsets.Micro.is_quarter_start\
pandas.tseries.offsets.Micro.is_year_end\
pandas.tseries.offsets.Micro.is_year_start\
pandas.tseries.offsets.Milli.is_month_end\
pandas.tseries.offsets.Milli.is_month_start\
pandas.tseries.offsets.Milli.is_quarter_end\
pandas.tseries.offsets.Milli.is_quarter_start\
pandas.tseries.offsets.Milli.is_year_end\
pandas.tseries.offsets.Milli.is_year_start\
pandas.tseries.offsets.Minute.is_month_end\
pandas.tseries.offsets.Minute.is_month_start\
pandas.tseries.offsets.Minute.is_quarter_end\
pandas.tseries.offsets.Minute.is_quarter_start\
pandas.tseries.offsets.Minute.is_year_end\
pandas.tseries.offsets.Minute.is_year_start\
pandas.tseries.offsets.MonthBegin.is_month_end\
pandas.tseries.offsets.MonthBegin.is_month_start\
pandas.tseries.offsets.MonthBegin.is_quarter_end\
pandas.tseries.offsets.MonthBegin.is_quarter_start\
pandas.tseries.offsets.MonthBegin.is_year_end\
pandas.tseries.offsets.MonthBegin.is_year_start\
pandas.tseries.offsets.MonthEnd.is_month_end\
pandas.tseries.offsets.MonthEnd.is_month_start\
pandas.tseries.offsets.MonthEnd.is_quarter_end\
pandas.tseries.offsets.MonthEnd.is_quarter_start\
pandas.tseries.offsets.MonthEnd.is_year_end\
pandas.tseries.offsets.MonthEnd.is_year_start\
pandas.tseries.offsets.Nano.is_month_end\
pandas.tseries.offsets.Nano.is_month_start\
pandas.tseries.offsets.Nano.is_quarter_end\
pandas.tseries.offsets.Nano.is_quarter_start\
pandas.tseries.offsets.Nano.is_year_end\
pandas.tseries.offsets.Nano.is_year_start\
pandas.tseries.offsets.QuarterBegin.is_month_end\
pandas.tseries.offsets.QuarterBegin.is_month_start\
pandas.tseries.offsets.QuarterBegin.is_quarter_end\
pandas.tseries.offsets.QuarterBegin.is_quarter_start\
pandas.tseries.offsets.QuarterBegin.is_year_end\
pandas.tseries.offsets.QuarterBegin.is_year_start\
pandas.tseries.offsets.QuarterEnd.is_month_end\
pandas.tseries.offsets.QuarterEnd.is_month_start\
pandas.tseries.offsets.QuarterEnd.is_quarter_end\
pandas.tseries.offsets.QuarterEnd.is_quarter_start\
pandas.tseries.offsets.QuarterEnd.is_year_end\
pandas.tseries.offsets.QuarterEnd.is_year_start\
pandas.tseries.offsets.Second.is_month_end\
pandas.tseries.offsets.Second.is_month_start\
pandas.tseries.offsets.Second.is_quarter_end\
pandas.tseries.offsets.Second.is_quarter_start\
pandas.tseries.offsets.Second.is_year_end\
pandas.tseries.offsets.Second.is_year_start\
pandas.tseries.offsets.SemiMonthBegin.is_month_end\
pandas.tseries.offsets.SemiMonthBegin.is_month_start\
pandas.tseries.offsets.SemiMonthBegin.is_quarter_end\
pandas.tseries.offsets.SemiMonthBegin.is_quarter_start\
pandas.tseries.offsets.SemiMonthBegin.is_year_end\
pandas.tseries.offsets.SemiMonthBegin.is_year_start\
pandas.tseries.offsets.SemiMonthEnd.is_month_end\
pandas.tseries.offsets.SemiMonthEnd.is_month_start\
pandas.tseries.offsets.SemiMonthEnd.is_quarter_end\
pandas.tseries.offsets.SemiMonthEnd.is_quarter_start\
pandas.tseries.offsets.SemiMonthEnd.is_year_end\
pandas.tseries.offsets.SemiMonthEnd.is_year_start\
pandas.tseries.offsets.Tick.is_month_end\
pandas.tseries.offsets.Tick.is_month_start\
pandas.tseries.offsets.Tick.is_quarter_end\
pandas.tseries.offsets.Tick.is_quarter_start\
pandas.tseries.offsets.Tick.is_year_end\
pandas.tseries.offsets.Tick.is_year_start\
pandas.tseries.offsets.Week.is_month_end\
pandas.tseries.offsets.Week.is_month_start\
pandas.tseries.offsets.Week.is_quarter_end\
pandas.tseries.offsets.Week.is_quarter_start\
pandas.tseries.offsets.Week.is_year_end\
pandas.tseries.offsets.Week.is_year_start\
pandas.tseries.offsets.WeekOfMonth.is_month_end\
pandas.tseries.offsets.WeekOfMonth.is_month_start\
pandas.tseries.offsets.WeekOfMonth.is_quarter_end\
pandas.tseries.offsets.WeekOfMonth.is_quarter_start\
pandas.tseries.offsets.WeekOfMonth.is_year_end\
pandas.tseries.offsets.WeekOfMonth.is_year_start\
pandas.tseries.offsets.YearBegin.is_month_end\
pandas.tseries.offsets.YearBegin.is_month_start\
pandas.tseries.offsets.YearBegin.is_quarter_end\
pandas.tseries.offsets.YearBegin.is_quarter_start\
pandas.tseries.offsets.YearBegin.is_year_end\
pandas.tseries.offsets.YearBegin.is_year_start\
pandas.tseries.offsets.YearEnd.is_month_end\
pandas.tseries.offsets.YearEnd.is_month_start\
pandas.tseries.offsets.YearEnd.is_quarter_end\
pandas.tseries.offsets.YearEnd.is_quarter_start\
pandas.tseries.offsets.YearEnd.is_year_end\
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
RET=$(($RET + $?)) ; echo $MSG "DONE"

MSG='Partially validate docstrings (PR07)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
pandas.DataFrame.align\
Expand Down

0 comments on commit 1ed627a

Please sign in to comment.