Skip to content

Commit

Permalink
docs(faq): Add more debugging steps
Browse files Browse the repository at this point in the history
Inspired by #909
  • Loading branch information
epage committed Jan 23, 2024
1 parent bdcaedb commit 9121fd0
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,21 @@ If you need to dig in more, you can enable debug logging with `-v`

### Why was ... not corrected?

tl;dr `typos` doesn't know about it yet
**Does the file show up in `typos --files`?**
If not, check your config with `typos --dump-config -`.
The `[files]` table controls how we walk files.
If you are using `files.extend-exclude`,
are you running into [#593](https://github.com/crate-ci/typos/issues/593)?
If you are using `files.ignore-vcs = true`,
is the file in your `.gitignore` but git tracks it anyways?
Prefer allowing the file explicitly (see [#909](https://github.com/crate-ci/typos/issues/909)).

**Does the identifier show up in `typos --identifers` or the word show up in `typos --words`?**
If not, it might be subject to one of typos' heuristics for
detecting non-words (like hashes) or
unambiguous words (like words after a `\` escape).

If it is showing up, likely `typos` doesn't know about it yet.

`typos` maintains a list of known typo corrections to keep the false positive
count low so it can safely run unassisted.
Expand Down

0 comments on commit 9121fd0

Please sign in to comment.