Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Apr 6, 2024

Conversation

jimrybarski
Copy link
Contributor

@jimrybarski jimrybarski commented Sep 10, 2023

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)

  • Changes are covered by unit tests (no major decrease in code coverage %).
  • All tests pass.
  • Docstring coverage is 100% via tox -e docs or interrogate -c pyproject.toml (I mean, we should set a good example 😄).
  • Updates to documentation:
    • Document any relevant additions/changes in README.rst.
    • Manually update both the README.rst and docs/index.rst for any new/changed CLI flags.
    • Any changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives. Find the appropriate next version in the project's __init__.py file.

Release note

NONE

Copy link
Owner

@econchick econchick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

belated thank you!

@econchick econchick merged commit dc84ec8 into econchick:master Apr 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants