Skip to content

Commit a15711d

Browse files
authored
DOC: Added list of functions to ignore EX03 test (#54406)
Added ignore_func to code_checks
1 parent a3d6c36 commit a15711d

File tree

1 file changed

+112
-0
lines changed

1 file changed

+112
-0
lines changed

ci/code_checks.sh

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,118 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
6161
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01,EX02,EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT02,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06
6262
RET=$(($RET + $?)) ; echo $MSG "DONE"
6363

64+
MSG='Partially validate docstrings (EX03)' ; echo $MSG
65+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX03 --ignore_functions \
66+
pandas.Series.loc \
67+
pandas.Series.iloc \
68+
pandas.Series.pop \
69+
pandas.Series.describe \
70+
pandas.Series.skew \
71+
pandas.Series.var \
72+
pandas.Series.last \
73+
pandas.Series.tz_convert \
74+
pandas.Series.tz_localize \
75+
pandas.Series.dt.month_name \
76+
pandas.Series.dt.day_name \
77+
pandas.Series.str.len \
78+
pandas.Series.cat.set_categories \
79+
pandas.Series.plot.bar \
80+
pandas.Series.plot.hist \
81+
pandas.Series.plot.line \
82+
pandas.Series.to_sql \
83+
pandas.Series.to_latex \
84+
pandas.errors.CategoricalConversionWarning \
85+
pandas.errors.ChainedAssignmentError \
86+
pandas.errors.ClosedFileError \
87+
pandas.errors.DatabaseError \
88+
pandas.errors.IndexingError \
89+
pandas.errors.InvalidColumnName \
90+
pandas.errors.NumExprClobberingError \
91+
pandas.errors.PossibleDataLossError \
92+
pandas.errors.PossiblePrecisionLoss \
93+
pandas.errors.SettingWithCopyError \
94+
pandas.errors.SettingWithCopyWarning \
95+
pandas.errors.SpecificationError \
96+
pandas.errors.UndefinedVariableError \
97+
pandas.errors.ValueLabelTypeMismatch \
98+
pandas.Timestamp.ceil \
99+
pandas.Timestamp.floor \
100+
pandas.Timestamp.round \
101+
pandas.read_pickle \
102+
pandas.ExcelWriter \
103+
pandas.read_json \
104+
pandas.io.json.build_table_schema \
105+
pandas.DataFrame.to_latex \
106+
pandas.io.formats.style.Styler.to_latex \
107+
pandas.read_parquet \
108+
pandas.DataFrame.to_sql \
109+
pandas.read_stata \
110+
pandas.core.resample.Resampler.pipe \
111+
pandas.core.resample.Resampler.fillna \
112+
pandas.core.resample.Resampler.interpolate \
113+
pandas.plotting.scatter_matrix \
114+
pandas.pivot \
115+
pandas.merge_asof \
116+
pandas.wide_to_long \
117+
pandas.Index.rename \
118+
pandas.Index.droplevel \
119+
pandas.Index.isin \
120+
pandas.CategoricalIndex.set_categories \
121+
pandas.MultiIndex.names \
122+
pandas.MultiIndex.droplevel \
123+
pandas.IndexSlice \
124+
pandas.DatetimeIndex.month_name \
125+
pandas.DatetimeIndex.day_name \
126+
pandas.core.window.rolling.Rolling.corr \
127+
pandas.Grouper \
128+
pandas.core.groupby.SeriesGroupBy.apply \
129+
pandas.core.groupby.DataFrameGroupBy.apply \
130+
pandas.core.groupby.SeriesGroupBy.transform \
131+
pandas.core.groupby.SeriesGroupBy.pipe \
132+
pandas.core.groupby.DataFrameGroupBy.pipe \
133+
pandas.core.groupby.DataFrameGroupBy.describe \
134+
pandas.core.groupby.DataFrameGroupBy.idxmax \
135+
pandas.core.groupby.DataFrameGroupBy.idxmin \
136+
pandas.core.groupby.DataFrameGroupBy.value_counts \
137+
pandas.core.groupby.SeriesGroupBy.describe \
138+
pandas.core.groupby.DataFrameGroupBy.boxplot \
139+
pandas.core.groupby.DataFrameGroupBy.hist \
140+
pandas.io.formats.style.Styler.map \
141+
pandas.io.formats.style.Styler.apply_index \
142+
pandas.io.formats.style.Styler.map_index \
143+
pandas.io.formats.style.Styler.format \
144+
pandas.io.formats.style.Styler.format_index \
145+
pandas.io.formats.style.Styler.relabel_index \
146+
pandas.io.formats.style.Styler.hide \
147+
pandas.io.formats.style.Styler.set_td_classes \
148+
pandas.io.formats.style.Styler.set_tooltips \
149+
pandas.io.formats.style.Styler.set_uuid \
150+
pandas.io.formats.style.Styler.pipe \
151+
pandas.io.formats.style.Styler.highlight_between \
152+
pandas.io.formats.style.Styler.highlight_quantile \
153+
pandas.io.formats.style.Styler.background_gradient \
154+
pandas.io.formats.style.Styler.text_gradient \
155+
pandas.DataFrame.values \
156+
pandas.DataFrame.loc \
157+
pandas.DataFrame.iloc \
158+
pandas.DataFrame.groupby \
159+
pandas.DataFrame.describe \
160+
pandas.DataFrame.skew \
161+
pandas.DataFrame.var \
162+
pandas.DataFrame.idxmax \
163+
pandas.DataFrame.idxmin \
164+
pandas.DataFrame.last \
165+
pandas.DataFrame.pivot \
166+
pandas.DataFrame.sort_values \
167+
pandas.DataFrame.tz_convert \
168+
pandas.DataFrame.tz_localize \
169+
pandas.DataFrame.plot.bar \
170+
pandas.DataFrame.plot.hexbin \
171+
pandas.DataFrame.plot.hist \
172+
pandas.DataFrame.plot.line \
173+
pandas.DataFrame.hist \
174+
RET=$(($RET + $?)) ; echo $MSG "DONE"
175+
64176
fi
65177

66178
### DOCUMENTATION NOTEBOOKS ###

0 commit comments

Comments
 (0)