Skip to content

Commit

Permalink
Add a section on typos to README
Browse files Browse the repository at this point in the history
  • Loading branch information
philderbeast committed Nov 28, 2024
1 parent b346c30 commit 3e45e4c
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,25 @@ either from the root of the cabal repository or from the `docs/` subdirectory. Y

In some cases, you may have to add a bound manually to `requirements.in`, e.g. `requests >= 2.31.0`.

### How to check spelling

To check for typos, run `make typos` and to fix them, run `make fix-typos`. Fixing might fail.

> If there is any ambiguity (multiple possible corrections), `typos` will just report it to the user and move on.
> `typos` [Getting Started](https://github.com/crate-ci/typos#getting-started)
```
make typos
typos **/*.rst
error: `managable` should be `manageable`, `manageably`
--> doc/getting-started.rst:75:6
|
75 | more managable building blocks.
| ^^^^^^^^^
|
make: *** [Makefile: typos] Error 2
```

### Gitpod workflow

From a fork of cabal, these docs can be edited online with
Expand Down

0 comments on commit 3e45e4c

Please sign in to comment.