econchick / interrogate

Explain yourself! Interrogate a codebase for docstring coverage.
https://interrogate.readthedocs.io
MIT License
562 stars 46 forks source link

Document configuration required to allow file exclusion via config file #159

Closed jimrybarski closed 3 months ago

jimrybarski commented 10 months ago

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)

Release note

NONE