Implement typos
spell-checker into PUDL code and documentation
#3783
Labels
docs
Documentation for users and contributors.
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 withpre-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.
The text was updated successfully, but these errors were encountered: