From b38d05b94140eb5e1e0401e26cb8402cf333a0f8 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Fri, 2 Dec 2022 10:05:09 -0600 Subject: [PATCH] docs: Clarify word vs identifier --- README.md | 2 +- docs/reference.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb1c661..ba6b081 100644 --- a/README.md +++ b/README.md @@ -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. -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 [default.extend-identifiers] # *sigh* this just isn't worth the cost of fixing diff --git a/docs/reference.md b/docs/reference.md index 12b9b5f..08fcf3f 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -27,7 +27,7 @@ Configuration is read from the following (in precedence order) | default.check-file | \- | bool | Verifying spelling in files. | | 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.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. | | type.\.\ | \ | \ | See `default.` for child keys. Run with `--type-list` to see available ``s | | type.\.extend_globs | \- | list of strings | File globs for matching `` |