Add pydoclint pre-commit hook #4357
Draft
+186
−172
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.
Overview
Adds a docstring linter to our pre-commit hooks.
It seems like it primarily lints for adherence to the Google (in our case) or NumPy docstring formatting conventions, and doesn't seem to look for RST errors, of which we have many.
Currently there are hundreds of errors, and we would need to tweak the configuration and/or save a "baseline" so that we can deal with the backlog of issues at our leisure.
pudl.transform.ferc1
pyproject.toml