Skip to content
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

Implement typos spell-checker into PUDL code and documentation #3783

Open
e-belfer opened this issue Aug 12, 2024 · 0 comments
Open

Implement typos spell-checker into PUDL code and documentation #3783

e-belfer opened this issue Aug 12, 2024 · 0 comments
Labels
docs Documentation for users and contributors.

Comments

@e-belfer
Copy link
Member

Is your feature request related to a problem? Please describe.
Our codebase is full of little typos that we catch and correct in an ad-hoc way (see, e.g., #3754).

Describe the solution you'd like
We implement a spell-checker into our pre-commit hooks. typos seems to be a fast, actively-maintained spell-checker that integrates with pre-commit and Github actions.

Implementing this will almost certainly require one large PR to fix existing changes and populate an exceptions list (e.g., PUDL will certainly fail the spellchecker).

Describe alternatives you've considered
We do a manual read-through of all our code for errors, or integrate spell checkers into our personal IDEs. Both of these approaches are ad-hoc and require ongoing implementation effort, which we are unlikely to do.

@e-belfer e-belfer added the docs Documentation for users and contributors. label Aug 12, 2024
@e-belfer e-belfer changed the title Implement typos spell-checking into PUDL code and documentation Implement typos spell-checker into PUDL code and documentation Aug 12, 2024
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

When branches are created from issues, their pull requests are automatically linked.

1 participant