jackmckew/Python Interrogate Check
Customisable GitHub action to use interrogate to check Python docstring coverage in your repository
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Nov 12, 2024
- License
- MIT
Pinned Snippet
uses: jackmckew/python-interrogate-check@122930cf7e046c18fd404cc339ae1936b3ff997b # v0.1.2tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| path | File or directory to run interrogate on. | yes | — |
| fail-under | Fail when coverage % is less than a given amount. | no | 80 |
| ignore-module | Ignore module-level docstrings | no | false |
| verbose | Show verbose output | no | false |
| badge-location | Generate a `shields.io` status badge (an SVG image) in at a given file or directory. | no | . |
Outputs
| name | description |
|---|---|
| output | The output of interrogate. |