You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Added "exclude_files" option for pyproject.toml config usage. (#635)
* feat(numpydoc/hooks/validate_docstrings.py): Added a pyproject.toml config option `exclude_files` that allows regex path exclusions
Solution to Issue #497
* fix(test_validate_hook.py): Corrected test for exclude_files toml option, which should have 0 findings
* refactor(test_validate_hook.py): Added extra testcase to verify no-matching exclude_files option
* refactor(test_validate_hook.py): Modified toml exclude_files test mark, to correct parameter order
* refactor(test_validate_hook.py): Change string type
* test(test_validate_hook.py): Added correct pyproject.toml and setup.cfg test cases for the `exclude_files` option
* feat(numpydoc.py): Added config option `numpydoc_validation_exclude_files` for Sphinx plugin
Uses very similar regex processing to `numpydoc_validation_exclude` but instead applies to a module check before any numpydoc validation is performed.
* fix(numpydoc.py): Corrected module path check for `numpydoc_validation_exclude_files` option
* refactor(numpydoc.py): Changed `numpydoc_validation_exclue_files` sphinx option to use `inspect`, and simplified path checking using `__file__`
* fix(Modified-`numpydoc_validation_exclude_files`-option-to-only-activate-if-`numpydoc_validation_checks`-is-not-empty): Mimicing same behaviour as `numpydoc_validation_exclude`
* docs(validation.rst,-install.rst): Added docs for new feature `numpydoc_validation_exclude_files` for Sphinx and `exclude_files` for pyproject.toml
* docs(validation.rst,-install.rst): Fixed indentation and linebreaks to properly format
* chore(numpydoc.py): use package-relative filename instead of absolute.
* docs(validation.rst,-install.rst): indicate relative path not absolute path for `exclude_files` options
0 commit comments