From a9735e2e141b9a8f08340e41aac57b52805ae185 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Mon, 6 Oct 2025 16:25:44 -0500 Subject: [PATCH] docs(ref): Provide identifier/word config examples --- docs/reference.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/reference.md b/docs/reference.md index fa31a3b2..098bee96 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -175,6 +175,16 @@ Custom uncorrectable sections (e.g. markdown code fences, PGP signatures, etc) Corrections for [identifiers](./design.md#identifiers-and-words). When the correction is blank, the identifier is never valid. When the correction is the key, the identifier is always valid. +Example: +```toml +[default.extend-identifiers] +## Names +Hte = "Hte" +## External +ERROR_FILENAME_EXCED_RANGE = "ERROR_FILENAME_EXCED_RANGE" +ERROR_FILENAME_EXCEDE_RANGE = "ERROR_FILENAME_EXCED_RANGE" +``` + #### `default.extend-ignore-identifiers-re` - Type: list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax) @@ -187,6 +197,14 @@ Pattern-match always-valid identifiers. Corrections for [words](./design.md#identifiers-and-words). When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. +Example: +```toml +[default.extend-words] +## Project-specific acronym +taits = "taits" +tais = "taits" +``` + #### `default.extend-ignore-words-re` - Type: list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax)