Skip to content

Commit b0b8a97

Browse files
jordan-d-murphypmhatre1
authored andcommitted
CI/DOC: Enforce RT03 in CI (pandas-dev#57356)
* Enforce RT03 in CI * added pandas.Index.to_numpy to RT03 ignore block
1 parent 0fa878e commit b0b8a97

File tree

1 file changed

+272
-0
lines changed

1 file changed

+272
-0
lines changed

ci/code_checks.sh

+272
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,278 @@ 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 (RT03)' ; echo $MSG
145+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT03 --ignore_functions \
146+
pandas.Index.to_numpy\
147+
pandas.Categorical.set_categories\
148+
pandas.CategoricalIndex.set_categories\
149+
pandas.DataFrame.astype\
150+
pandas.DataFrame.at_time\
151+
pandas.DataFrame.ewm\
152+
pandas.DataFrame.expanding\
153+
pandas.DataFrame.filter\
154+
pandas.DataFrame.first_valid_index\
155+
pandas.DataFrame.get\
156+
pandas.DataFrame.hist\
157+
pandas.DataFrame.infer_objects\
158+
pandas.DataFrame.kurt\
159+
pandas.DataFrame.kurtosis\
160+
pandas.DataFrame.last_valid_index\
161+
pandas.DataFrame.mask\
162+
pandas.DataFrame.max\
163+
pandas.DataFrame.mean\
164+
pandas.DataFrame.median\
165+
pandas.DataFrame.min\
166+
pandas.DataFrame.nsmallest\
167+
pandas.DataFrame.nunique\
168+
pandas.DataFrame.pipe\
169+
pandas.DataFrame.plot.box\
170+
pandas.DataFrame.plot.density\
171+
pandas.DataFrame.plot.kde\
172+
pandas.DataFrame.plot.scatter\
173+
pandas.DataFrame.pop\
174+
pandas.DataFrame.prod\
175+
pandas.DataFrame.product\
176+
pandas.DataFrame.reindex\
177+
pandas.DataFrame.reorder_levels\
178+
pandas.DataFrame.sem\
179+
pandas.DataFrame.skew\
180+
pandas.DataFrame.std\
181+
pandas.DataFrame.sum\
182+
pandas.DataFrame.swapaxes\
183+
pandas.DataFrame.to_numpy\
184+
pandas.DataFrame.to_orc\
185+
pandas.DataFrame.to_parquet\
186+
pandas.DataFrame.unstack\
187+
pandas.DataFrame.value_counts\
188+
pandas.DataFrame.var\
189+
pandas.DataFrame.where\
190+
pandas.DatetimeIndex.indexer_at_time\
191+
pandas.DatetimeIndex.indexer_between_time\
192+
pandas.DatetimeIndex.snap\
193+
pandas.DatetimeIndex.std\
194+
pandas.DatetimeIndex.to_period\
195+
pandas.DatetimeIndex.to_pydatetime\
196+
pandas.DatetimeIndex.tz_convert\
197+
pandas.HDFStore.info\
198+
pandas.Index.append\
199+
pandas.Index.difference\
200+
pandas.Index.drop_duplicates\
201+
pandas.Index.droplevel\
202+
pandas.Index.dropna\
203+
pandas.Index.duplicated\
204+
pandas.Index.fillna\
205+
pandas.Index.get_loc\
206+
pandas.Index.insert\
207+
pandas.Index.intersection\
208+
pandas.Index.join\
209+
pandas.Index.memory_usage\
210+
pandas.Index.nunique\
211+
pandas.Index.putmask\
212+
pandas.Index.ravel\
213+
pandas.Index.slice_indexer\
214+
pandas.Index.slice_locs\
215+
pandas.Index.symmetric_difference\
216+
pandas.Index.to_list\
217+
pandas.Index.union\
218+
pandas.Index.unique\
219+
pandas.Index.value_counts\
220+
pandas.IntervalIndex.contains\
221+
pandas.IntervalIndex.get_loc\
222+
pandas.IntervalIndex.set_closed\
223+
pandas.IntervalIndex.to_tuples\
224+
pandas.MultiIndex.copy\
225+
pandas.MultiIndex.drop\
226+
pandas.MultiIndex.droplevel\
227+
pandas.MultiIndex.remove_unused_levels\
228+
pandas.MultiIndex.reorder_levels\
229+
pandas.MultiIndex.set_levels\
230+
pandas.MultiIndex.to_frame\
231+
pandas.PeriodIndex.to_timestamp\
232+
pandas.Series.__iter__\
233+
pandas.Series.astype\
234+
pandas.Series.at_time\
235+
pandas.Series.case_when\
236+
pandas.Series.cat.set_categories\
237+
pandas.Series.dt.to_period\
238+
pandas.Series.dt.tz_convert\
239+
pandas.Series.ewm\
240+
pandas.Series.expanding\
241+
pandas.Series.filter\
242+
pandas.Series.first_valid_index\
243+
pandas.Series.get\
244+
pandas.Series.infer_objects\
245+
pandas.Series.kurt\
246+
pandas.Series.kurtosis\
247+
pandas.Series.last_valid_index\
248+
pandas.Series.mask\
249+
pandas.Series.max\
250+
pandas.Series.mean\
251+
pandas.Series.median\
252+
pandas.Series.min\
253+
pandas.Series.nunique\
254+
pandas.Series.pipe\
255+
pandas.Series.plot.box\
256+
pandas.Series.plot.density\
257+
pandas.Series.plot.kde\
258+
pandas.Series.pop\
259+
pandas.Series.prod\
260+
pandas.Series.product\
261+
pandas.Series.reindex\
262+
pandas.Series.reorder_levels\
263+
pandas.Series.sem\
264+
pandas.Series.skew\
265+
pandas.Series.sparse.to_coo\
266+
pandas.Series.std\
267+
pandas.Series.str.capitalize\
268+
pandas.Series.str.casefold\
269+
pandas.Series.str.center\
270+
pandas.Series.str.decode\
271+
pandas.Series.str.encode\
272+
pandas.Series.str.find\
273+
pandas.Series.str.fullmatch\
274+
pandas.Series.str.get\
275+
pandas.Series.str.index\
276+
pandas.Series.str.ljust\
277+
pandas.Series.str.lower\
278+
pandas.Series.str.lstrip\
279+
pandas.Series.str.match\
280+
pandas.Series.str.normalize\
281+
pandas.Series.str.partition\
282+
pandas.Series.str.rfind\
283+
pandas.Series.str.rindex\
284+
pandas.Series.str.rjust\
285+
pandas.Series.str.rpartition\
286+
pandas.Series.str.rstrip\
287+
pandas.Series.str.strip\
288+
pandas.Series.str.swapcase\
289+
pandas.Series.str.title\
290+
pandas.Series.str.translate\
291+
pandas.Series.str.upper\
292+
pandas.Series.str.wrap\
293+
pandas.Series.str.zfill\
294+
pandas.Series.sum\
295+
pandas.Series.to_list\
296+
pandas.Series.to_numpy\
297+
pandas.Series.to_timestamp\
298+
pandas.Series.value_counts\
299+
pandas.Series.var\
300+
pandas.Series.where\
301+
pandas.TimedeltaIndex.as_unit\
302+
pandas.TimedeltaIndex.to_pytimedelta\
303+
pandas.api.extensions.ExtensionArray._accumulate\
304+
pandas.api.extensions.ExtensionArray._hash_pandas_object\
305+
pandas.api.extensions.ExtensionArray._pad_or_backfill\
306+
pandas.api.extensions.ExtensionArray._reduce\
307+
pandas.api.extensions.ExtensionArray.copy\
308+
pandas.api.extensions.ExtensionArray.dropna\
309+
pandas.api.extensions.ExtensionArray.duplicated\
310+
pandas.api.extensions.ExtensionArray.insert\
311+
pandas.api.extensions.ExtensionArray.isin\
312+
pandas.api.extensions.ExtensionArray.ravel\
313+
pandas.api.extensions.ExtensionArray.take\
314+
pandas.api.extensions.ExtensionArray.tolist\
315+
pandas.api.extensions.ExtensionArray.unique\
316+
pandas.api.interchange.from_dataframe\
317+
pandas.api.types.is_hashable\
318+
pandas.api.types.pandas_dtype\
319+
pandas.api.types.union_categoricals\
320+
pandas.arrays.IntervalArray.contains\
321+
pandas.arrays.IntervalArray.set_closed\
322+
pandas.arrays.IntervalArray.to_tuples\
323+
pandas.bdate_range\
324+
pandas.core.groupby.DataFrameGroupBy.__iter__\
325+
pandas.core.groupby.DataFrameGroupBy.agg\
326+
pandas.core.groupby.DataFrameGroupBy.aggregate\
327+
pandas.core.groupby.DataFrameGroupBy.apply\
328+
pandas.core.groupby.DataFrameGroupBy.boxplot\
329+
pandas.core.groupby.DataFrameGroupBy.cummax\
330+
pandas.core.groupby.DataFrameGroupBy.cummin\
331+
pandas.core.groupby.DataFrameGroupBy.cumprod\
332+
pandas.core.groupby.DataFrameGroupBy.cumsum\
333+
pandas.core.groupby.DataFrameGroupBy.filter\
334+
pandas.core.groupby.DataFrameGroupBy.get_group\
335+
pandas.core.groupby.DataFrameGroupBy.hist\
336+
pandas.core.groupby.DataFrameGroupBy.mean\
337+
pandas.core.groupby.DataFrameGroupBy.nunique\
338+
pandas.core.groupby.DataFrameGroupBy.rank\
339+
pandas.core.groupby.DataFrameGroupBy.resample\
340+
pandas.core.groupby.DataFrameGroupBy.skew\
341+
pandas.core.groupby.DataFrameGroupBy.transform\
342+
pandas.core.groupby.SeriesGroupBy.__iter__\
343+
pandas.core.groupby.SeriesGroupBy.agg\
344+
pandas.core.groupby.SeriesGroupBy.aggregate\
345+
pandas.core.groupby.SeriesGroupBy.apply\
346+
pandas.core.groupby.SeriesGroupBy.cummax\
347+
pandas.core.groupby.SeriesGroupBy.cummin\
348+
pandas.core.groupby.SeriesGroupBy.cumprod\
349+
pandas.core.groupby.SeriesGroupBy.cumsum\
350+
pandas.core.groupby.SeriesGroupBy.filter\
351+
pandas.core.groupby.SeriesGroupBy.get_group\
352+
pandas.core.groupby.SeriesGroupBy.mean\
353+
pandas.core.groupby.SeriesGroupBy.rank\
354+
pandas.core.groupby.SeriesGroupBy.resample\
355+
pandas.core.groupby.SeriesGroupBy.skew\
356+
pandas.core.groupby.SeriesGroupBy.transform\
357+
pandas.core.resample.Resampler.__iter__\
358+
pandas.core.resample.Resampler.ffill\
359+
pandas.core.resample.Resampler.get_group\
360+
pandas.core.resample.Resampler.max\
361+
pandas.core.resample.Resampler.min\
362+
pandas.core.resample.Resampler.transform\
363+
pandas.date_range\
364+
pandas.interval_range\
365+
pandas.io.formats.style.Styler.apply\
366+
pandas.io.formats.style.Styler.apply_index\
367+
pandas.io.formats.style.Styler.background_gradient\
368+
pandas.io.formats.style.Styler.bar\
369+
pandas.io.formats.style.Styler.concat\
370+
pandas.io.formats.style.Styler.export\
371+
pandas.io.formats.style.Styler.format\
372+
pandas.io.formats.style.Styler.format_index\
373+
pandas.io.formats.style.Styler.hide\
374+
pandas.io.formats.style.Styler.highlight_between\
375+
pandas.io.formats.style.Styler.highlight_max\
376+
pandas.io.formats.style.Styler.highlight_min\
377+
pandas.io.formats.style.Styler.highlight_null\
378+
pandas.io.formats.style.Styler.highlight_quantile\
379+
pandas.io.formats.style.Styler.map\
380+
pandas.io.formats.style.Styler.map_index\
381+
pandas.io.formats.style.Styler.relabel_index\
382+
pandas.io.formats.style.Styler.set_caption\
383+
pandas.io.formats.style.Styler.set_properties\
384+
pandas.io.formats.style.Styler.set_sticky\
385+
pandas.io.formats.style.Styler.set_table_attributes\
386+
pandas.io.formats.style.Styler.set_table_styles\
387+
pandas.io.formats.style.Styler.set_td_classes\
388+
pandas.io.formats.style.Styler.set_tooltips\
389+
pandas.io.formats.style.Styler.set_uuid\
390+
pandas.io.formats.style.Styler.text_gradient\
391+
pandas.io.formats.style.Styler.use\
392+
pandas.io.json.build_table_schema\
393+
pandas.io.stata.StataReader.value_labels\
394+
pandas.io.stata.StataReader.variable_labels\
395+
pandas.json_normalize\
396+
pandas.merge_asof\
397+
pandas.period_range\
398+
pandas.plotting.andrews_curves\
399+
pandas.plotting.autocorrelation_plot\
400+
pandas.plotting.lag_plot\
401+
pandas.plotting.parallel_coordinates\
402+
pandas.plotting.radviz\
403+
pandas.plotting.table\
404+
pandas.read_feather\
405+
pandas.read_orc\
406+
pandas.read_sas\
407+
pandas.read_spss\
408+
pandas.read_sql\
409+
pandas.read_sql_query\
410+
pandas.read_stata\
411+
pandas.set_eng_float_format\
412+
pandas.timedelta_range\
413+
pandas.util.hash_pandas_object # There should be no backslash in the final line, please keep this comment in the last ignored function
414+
RET=$(($RET + $?)) ; echo $MSG "DONE"
415+
144416
MSG='Partially validate docstrings (SA01)' ; echo $MSG
145417
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA01 --ignore_functions \
146418
pandas.ArrowDtype\

0 commit comments

Comments
 (0)