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

Add codespell to precommit and fix typos found #424

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rdimaio
Copy link
Contributor

@rdimaio rdimaio commented Dec 17, 2024

fixes #423

@voetberg
Copy link
Contributor

Some questions:

  • Do we have a way to whitelist certain words? Codespell does a pretty good job but I have noticed it gets mad about things like rses.
  • Do we have a way to one-off ignore suggestions? Like the # ignore tag but for md?
  • Can you include instructions to run the precommit locally?

@rdimaio
Copy link
Contributor Author

rdimaio commented Dec 17, 2024

* Do we have a way to whitelist certain words? Codespell does a pretty good job but I have noticed it gets mad about things like `rses`.

Yes: https://github.com/codespell-project/codespell?tab=readme-ov-file#using-a-config-file

[codespell]
dictionary = mydict,-
ignore-words-list = bar,-foo
* Do we have a way to one-off ignore suggestions? Like the `# ignore` tag but for md?

Yes: https://github.com/codespell-project/codespell?tab=readme-ov-file#inline-ignore

* Can you include instructions to run the precommit locally?

It should just be a matter of installing the precommit, along the lines of https://rucio.github.io/documentation/contributing/#1-prerequisite - I could add the same instructions here: https://github.com/rucio/documentation/blob/main/CONTRIBUTING.md
edit: just realized that the contributing guide for the docs repo already has installation instructions: https://github.com/rucio/documentation/blob/main/CONTRIBUTING.md#git-hooks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add spellchecking in pre-commit
2 participants