Feature/Enforce docstring code coverage. #271
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
DriesSmit
approved these changes
Jul 12, 2021
There was a problem hiding this comment.
Thanks, @KaleabTessera 🔥 This will definitely help us save time in the long run.
arnupretorius
approved these changes
Jul 12, 2021
|
Sound good to me 👍 Will it check the structure though? E.g. a description of the function, plus each arg, and the return? Or is it only checking that each function has """some text"""? |
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.
What?
Added
interogatepackage to check and enforce docstring code coverage.Why?
Better quality code documentation.
How?
Extra
Currently, the pre-commits will fail if docstring code coverage is less than 54.4% (our current docstring coverage is 54.5%). This will prevent new code without docstrings from being committed and we can increase this percentage as we go along. @arnupretorius Sounds good?