Add docstrings to config module #371
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://interrogate.readthedocs.io/ helps to check the project's docstring coverage.
Pull Request Test Coverage Report for Build 10912154515Details
💛 - Coveralls |
The version of interrogate on JackMcKew/python-interrogate-check action is 1.2.0, which is too old.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #320. Docstring additions themselves are minimal. The bigger change is addition of an interrogate configuration, and a CI workflow to check docstring coverage.
Interrogate 1.7.0 reports that docstring coverage is at 92.6% (excluding tests, and old editor code). The CI workflow will report a failure if docstring coverage falls under this threshold. This is configured in
[tools.interrogate]section ofpyproject.toml.