actions-marketplace-validations/docstr-coverage
Run the docstr-coverage python package
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source_dir | Path to source root in repo | yes | — |
| fail_under | Fail if under a certain percentage of coverage (default: 100.0) | — | 100 |
| skip_magic | Ignore all magic methods (except __init__) | — | true |
| skip_init | Ignore all __init__ methods | — | true |
| skip_file_doc | Ignore module docstrings (at the top of files) | — | true |
| skip_private | Ignore private functions (starting with a single underscore) | — | true |
| skip_class_def | Ignore docstrings of class definitions | — | true |
| accept_empty | Exit with code 0 if no Python files are found (default: exit code 1) | — | false |
| docstr_ignore_file | Filepath containing list of patterns to ignore. Patterns are (file-pattern, name-pattern) pairs | — | "" |
| exclude | Filepath pattern to exclude from analysis | — | "" |
| verbose | Set verbosity level (0-3, default: 3) | — | 3 |
| badge | Generate a docstring coverage percent badge as an SVG saved to a given filepath | — | false |
| follow_links | Follow symlinks | — | false |
| percentage_only | Output only the overall coverage percentage as a float, silencing all other logging | — | false |
Outputs
| name | description |
|---|---|
| output | Contains the docstr coverage percentage of the provided source dir |