Skip to content

Commit a9735e2

Browse files
committed
docs(ref): Provide identifier/word config examples
1 parent 3c14191 commit a9735e2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/reference.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,16 @@ Custom uncorrectable sections (e.g. markdown code fences, PGP signatures, etc)
175175

176176
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.
177177

178+
Example:
179+
```toml
180+
[default.extend-identifiers]
181+
## Names
182+
Hte = "Hte"
183+
## External
184+
ERROR_FILENAME_EXCED_RANGE = "ERROR_FILENAME_EXCED_RANGE"
185+
ERROR_FILENAME_EXCEDE_RANGE = "ERROR_FILENAME_EXCED_RANGE"
186+
```
187+
178188
#### `default.extend-ignore-identifiers-re`
179189

180190
- Type: list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax)
@@ -187,6 +197,14 @@ Pattern-match always-valid identifiers.
187197

188198
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.
189199

200+
Example:
201+
```toml
202+
[default.extend-words]
203+
## Project-specific acronym
204+
taits = "taits"
205+
tais = "taits"
206+
```
207+
190208
#### `default.extend-ignore-words-re`
191209

192210
- Type: list of [regexes](https://docs.rs/regex/latest/regex/index.html#syntax)

0 commit comments

Comments
 (0)