Skip to content

Commit

Permalink
Remove misspell references
Browse files Browse the repository at this point in the history
  • Loading branch information
esasse committed Sep 15, 2023
1 parent 4a9974a commit 7c2e4fc
Showing 1 changed file with 1 addition and 15 deletions.
16 changes: 1 addition & 15 deletions guides/source/contributing_to_ruby_on_rails.md
Expand Up @@ -305,21 +305,7 @@ For `rails-ujs` CoffeeScript and JavaScript files, you can run `npm run lint` in

#### Spell Checking

We are running [misspell](https://github.com/client9/misspell) which is mainly written in
[Golang](https://golang.org/) to check spelling with [GitHub Actions](https://github.com/rails/rails/blob/main/.github/workflows/lint.yml). Correct
commonly misspelled English words quickly with `misspell`. `misspell` is different from most other spell checkers
because it doesn't use a custom dictionary. You can run `misspell` locally against all files with:

```bash
$ find . -type f | xargs ./misspell -i 'aircrafts,devels,invertions' -error
```

Notable `misspell` help options or flags are:

- `-i` string: ignore the following corrections, comma separated
- `-w`: Overwrite file with corrections (default is just to display)

We also run [codespell](https://github.com/codespell-project/codespell) with GitHub Actions to check spelling and
We run [codespell](https://github.com/codespell-project/codespell) with GitHub Actions to check spelling and
[codespell](https://pypi.org/project/codespell/) runs against a [small custom dictionary](https://github.com/rails/rails/blob/main/codespell.txt).
`codespell` is written in [Python](https://www.python.org/) and you can run it with:

Expand Down

0 comments on commit 7c2e4fc

Please sign in to comment.