Adding docstyle checking to pre-commit #2
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
The conventions ignored are: D100 Missing docstring in public module D104 Missing docstring in public package D200 One-line docstring should fit on one line with quotes Reasoning for D100 and D104 is that often these doc strings are beyond self-evident from the naming of the class or module. For D200 this is not always the case especially if we are stating the maxline length is 88.
jmp1985
approved these changes
Feb 2, 2024
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.
This will ensure a consistent documentation style is used throughout the Franklin.
Google is suggested as the committer's belief that it is the clearest and easy to parse.
The conventions ignored are:
D100 Missing docstring in public module
D104 Missing docstring in public package
D200 One-line docstring should fit on one line with quotes
The reasoning for D100 and D104 is that often; these doc strings are beyond self-evident from the naming of the class or module. For D200, this is not always the case, especially if we are stating the max line length is 88.