Adding pydoclint and properly format docstring #69
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
Codecov ReportAttention: Patch coverage is
|
rht
reviewed
Aug 20, 2024
| @@ -11,23 +11,11 @@ | |||
| class CopyMixin(ABC): | |||
| """A mixin class that provides a fast copy method for the class that inherits it. | |||
|
|
|||
| Attributes | |||
| ---------- | |||
| _copy_with_method : dict[str, tuple[str, list[str]]] | |||
There was a problem hiding this comment.
There are indeed quite a number of private attributes.
rht
approved these changes
Aug 20, 2024
|
@EwoutH we should enable this for projectmesa/mesa as well. |
|
Looks interesting indeed! |
|
Does it have a pre-commit hook? |
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 PR adds pydoclint as pre-commit hook to ensure having a proper formatting of docstrings (crucial for docs) and correct parameter/return types