interrogate
interrogate copied to clipboard
Explain yourself! Interrogate a codebase for docstring coverage.
### Environment - `interrogate` version(s) (`interrogate --version`): 1.5.0 - Operating System(s): macOS - Python version(s): 3.9.10 ### Description of the bug With `ignore-property-decorators` set to `true`, a property deleter is...
Bumps [actions/cache](https://github.com/actions/cache) from 3.0.5 to 3.0.7. Release notes Sourced from actions/cache's releases. v3.0.7 What's Changed Fix for the download stuck problem has been added in actions/cache for users who were...
Hi there, One thing currently not tested by the tool is class variables, i.e. class members or attributes. This is important when generating documentation from code. For example, both code...
Hiya, interrogate assumes I need to document both the class and its `__init__` method. Yet this is not required by tooling usually and is actually considered an anti-pattern - the...
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4. Release notes Sourced from actions/setup-python's releases. v4.0.0 What's Changed Support for python-version-file input: #336 Example of usage: - uses: actions/setup-python@v4 with: python-version-file: '.python-version' #...
### Environment - `interrogate` version(s) (`interrogate --version`: interrogate, version 1.5.0 - Operating System(s): Ubuntu 22.04 LTS - Python version(s): 3.10 ### Description of the bug Interrogate throws an exception (re.error)...
### Describe the feature you'd like When decorating functions with `@typing.overload`, the stubs are marked as not covered when they don't have their own docstring. My suggestion is to add...
In some cases, it may be useful to interrogate [.pyi files](https://mypy.readthedocs.io/en/stable/stubs.html) (i.e.: when checking docstring coverage of native Pybind11 modules). Interrogate can parse these files, but refuses to due to...
### Environment - `interrogate` version(s) (`interrogate --version`: 1.5.0 - Operating System(s): Linux - Python version(s): 3.10 ### Description of the bug Interrogate fails with new `match` syntax  ### What...
### Environment - `interrogate` version: 1.3.1 - Operating System(s): Windows - Python version(s): 3.7.7 ### Description of the bug Using the `-e/--exclude` argument works perfectly fine when using `interrogate` directly...