Skip to content

Add pydoclint pre-commit hook #4357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

zaneselvans
Copy link
Member

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.

  • Save a "baseline" of docstring errors to address later
  • Open an issue in the pydoclint repo about the crash on pudl.transform.ferc1
  • Experiment with additional configuration options in pyproject.toml
  • Look for an RST-specific docstring linter/formatter
  • Review the PR yourself and call out any questions or issues you have.

@zaneselvans zaneselvans added the docs Documentation for users and contributors. label Jun 25, 2025
Base automatically changed from spell-checker to main July 1, 2025 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation for users and contributors.
Projects
Status: New
Development

Successfully merging this pull request may close these issues.

1 participant