From 6773b4caa2d1a42a6ec4437c6e55a41214ec979f Mon Sep 17 00:00:00 2001 From: Ed Page Date: Mon, 2 Jan 2023 07:13:19 -0600 Subject: [PATCH] docs(ref): Define identifiers/words This came up in #646 --- docs/reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference.md b/docs/reference.md index 08fcf3f..84d1ea6 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 (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-identifiers | \- | table of strings | Corrections for identifiers (as defined by [unicode's `XID_Continue`](https://www.unicode.org/reports/tr31/)). 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 (split from identifiers). 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 `` |