Document configuration required to allow file exclusion via config file #159
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This adds a line to the README to clear up a common point of confusion.
Motivation and Context
pre-commit passes all source files as arguments to interrogate. Interrogate ignores any exclusion criteria in pyproject.toml or setup.cfg for files that are specified in this way. This gives the appearance that interrogate is ignoring configuration options. This has led to a number of issues, in particular #60, #100, #145, #155, and possibly #128.
Have you tested this? If so, how?
I have used this exact line in my own project and it works as intended.
Checklist for PR author(s)
tox -e docs
orinterrogate -c pyproject.toml
(I mean, we should set a good example 😄).README.rst
.README.rst
anddocs/index.rst
for any new/changed CLI flags.versionadded
,versionchanged
, ordeprecated
directives. Find the appropriate next version in the project's__init__.py
file.Release note