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

Analyze docstring coverage with interrogate. #82

Merged
merged 1 commit into from
Oct 6, 2023

Conversation

airwoodix
Copy link
Collaborator

@airwoodix airwoodix commented Oct 5, 2023

Summary

Use interrogate to analyze docstring coverage of modules in the qiskit_aqt_provider and test packages.

Details and comments

  • exclusions:
    • module top-level (could be added later, but not too relevant at the moment)
    • nested functions (usually implementation details, e.g. for decorators)
    • generated code.

There is a functionality to generate a badge with the docstring coverage, but I don't know how to get a link to an image artifact that's not a zip file...

@airwoodix airwoodix self-assigned this Oct 5, 2023
@airwoodix airwoodix merged commit 1992fa1 into master Oct 6, 2023
6 checks passed
@airwoodix airwoodix deleted the docstring-coverage branch October 6, 2023 05:53
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