fixup! DOC: Add ignore_functions option to validate_docstrings.py

Author: Moisan

ci/code_checks.sh

@@ -83,7 +83,9 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
     $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04,SS01,SS02,SS03,SS04,SS05,SS06
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
+    MSG='Partially validate docstrings (RT02)' ; echo $MSG
     $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT02 --ignore_functions=pandas.Series.align,pandas.Series.dt.total_seconds,pandas.Series.cat.rename_categories,pandas.Series.cat.reorder_categories,pandas.Series.cat.add_categories,pandas.Series.cat.remove_categories,pandas.Series.cat.remove_unused_categories,pandas.Index.all,pandas.Index.any,pandas.CategoricalIndex.rename_categories,pandas.CategoricalIndex.reorder_categories,pandas.CategoricalIndex.add_categories,pandas.CategoricalIndex.remove_categories,pandas.CategoricalIndex.remove_unused_categories,pandas.MultiIndex.drop,pandas.DatetimeIndex.to_pydatetime,pandas.TimedeltaIndex.to_pytimedelta,pandas.core.groupby.SeriesGroupBy.apply,pandas.core.groupby.DataFrameGroupBy.apply,pandas.io.formats.style.Styler.export,pandas.api.extensions.ExtensionArray.astype,pandas.api.extensions.ExtensionArray.dropna,pandas.api.extensions.ExtensionArray.isna,pandas.api.extensions.ExtensionArray.repeat,pandas.api.extensions.ExtensionArray.unique,pandas.DataFrame.align
+    RET=$(($RET + $?)) ; echo $MSG "DONE"
 
 fi
 

scripts/validate_docstrings.py

@@ -319,10 +319,7 @@ def validate_all(prefix, ignore_deprecated=False, ignore_functions=None):
     result = {}
     seen = {}
 
-    if ignore_functions is None:
-        ignore_functions = {}
-    else:
-        ignore_functions = set(ignore_functions)
+    ignore_functions = set(ignore_functions or [])
 
     base_path = pathlib.Path(__file__).parent.parent
     api_doc_fnames = pathlib.Path(base_path, "doc", "source", "reference")
@@ -332,9 +329,9 @@ def validate_all(prefix, ignore_deprecated=False, ignore_functions=None):
             api_items += list(get_api_items(f))
 
     for func_name, _, section, subsection in api_items:
-        if (
-            prefix and not func_name.startswith(prefix)
-        ) or func_name in ignore_functions:
+        if func_name in ignore_functions:
+            continue
+        if prefix and not func_name.startswith(prefix):
             continue
         doc_info = pandas_validate(func_name)
         if ignore_deprecated and doc_info["deprecated"]:
@@ -482,7 +479,7 @@ def main(func_name, prefix, errors, output_format, ignore_deprecated, ignore_fun
         "--ignore_functions",
         default=None,
         help="function or method to not validate "
-        "(e.g. Pandas.DataFrame.head). "
+        "(e.g. pandas.DataFrame.head). "
         "Inverse of the `function` argument.",
     )