Skip to content

Comments

Add codespell pre-commit hook#281

Merged
tsmbland merged 2 commits intodevelopfrom
codespell
Apr 25, 2024
Merged

Add codespell pre-commit hook#281
tsmbland merged 2 commits intodevelopfrom
codespell

Conversation

@alexdewar
Copy link
Collaborator

Description

As promised, here is a PR which adds the codespell pre-commit hook to check spelling in the code base and documentation and fixes up any errors found.

You can add words to be ignored to the .codespell_ignore.txt file. You can also ignore whole files with an extra argument to codespell, but I haven't needed to do that yet.

@alexdewar alexdewar requested review from dalonsoa and tsmbland April 24, 2024 09:34
Copy link
Collaborator

@tsmbland tsmbland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!

@tsmbland
Copy link
Collaborator

Not sure why the documentation build is failing, but I'm getting the same thing here

@alexdewar
Copy link
Collaborator Author

Weird... From the logs it doesn't look like it's something I've broken (phew!). I've set the job to re-run; hopefully it was just a fluke.

@dalonsoa
Copy link
Collaborator

Some flaky issue. Now it works after re-running the failing job.

Copy link
Collaborator

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A much needed addition!!

@tsmbland tsmbland merged commit 9df94e1 into develop Apr 25, 2024
@tsmbland tsmbland deleted the codespell branch April 25, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants