actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-24 10:00:59 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Clarify word vs identifier

Browse source
This commit is contained in:
Ed Page 2022-12-02 10:05:09 -06:00
parent 4637c964a3
commit b38d05b941
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -65,7 +65,7 @@ If there is any ambiguity (multiple possible corrections), `typos` will just rep
Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content. Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.
To mark an identifier or word as valid, add it your [`_typos.toml`](docs/reference.md) by declaring itself as the valid spelling: To mark a word or an identifer (grouping of words) as valid, add it your [`_typos.toml`](docs/reference.md) by declaring itself as the valid spelling:
```toml ```toml
[default.extend-identifiers] [default.extend-identifiers]
# *sigh* this just isn't worth the cost of fixing # *sigh* this just isn't worth the cost of fixing

2
docs/reference.md
View file

@ -27,7 +27,7 @@ Configuration is read from the following (in precedence order)
| default.check-file | \- | bool | Verifying spelling in files. | | default.check-file | \- | bool | Verifying spelling in files. |
| default.unicode | --unicode | bool | Allow unicode characters in identifiers (and not just ASCII) | | default.unicode | --unicode | bool | Allow unicode characters in identifiers (and not just ASCII) |
| default.locale | --locale | en, en-us, en-gb, en-ca, en-au | English dialect to correct to. | | default.locale | --locale | en, en-us, en-gb, en-ca, en-au | English dialect to correct to. |
| default.extend-identifiers | \- | table of strings | Corrections for identifiers. When the correction is blank, the identifier is never valid. When the correction is the key, the identifier is always valid. | | default.extend-identifiers | \- | table of strings | Corrections for identifiers (grouping of words). When the correction is blank, the identifier is never valid. When the correction is the key, the identifier is always valid. |
| default.extend-words | \- | table of strings | Corrections for words. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. | | default.extend-words | \- | table of strings | Corrections for words. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
| type.\<name>.\<field> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s | | type.\<name>.\<field> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s |
| type.\<name>.extend_globs | \- | list of strings | File globs for matching `<name>` | | type.\<name>.extend_globs | \- | list of strings | File globs for matching `<name>` |