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

Add action for checking documentation coverage #81

Merged
merged 32 commits into from
Jul 14, 2022

Conversation

stes
Copy link
Contributor

@stes stes commented Jul 9, 2022

@stes stes requested review from zimmerrol and kotekjedi July 9, 2022 23:32
@stes
Copy link
Contributor Author

stes commented Jul 9, 2022

WIP. This PR checks doc coverage (but could also report other things) and then generates & posts a report. I think it would be great to get this ready to automatically test all tasks, with actionable outputs for the authors.

@stes stes marked this pull request as draft July 10, 2022 05:10
.github/workflows/tests.yml Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Jul 12, 2022

Docstring Coverage Report

Name Total Miss Cover Cover%
base.py 7 0 7 100%
TOTAL 7 0 7 100.0%

RESULT: PASSED (minimum: 0.0%, actual: 100.0%)

@zimmerrol
Copy link
Collaborator

Once #86 is merged, we should update this PR and can then merge it, too.