actions/typos
0
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2026-10-17 09:35:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(ref): Clarify extend-words / extend-identifiers

Browse Source
This commit is contained in:
Ed Page
2025-11-17 10:07:09 -06:00
parent 626c4bedb7
commit 9f99fb8dfe
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference.md
+8 -2
View File
@@ -38,8 +38,10 @@ extend-ignore-identifiers-re = []
extend-ignore-words = []
[default.extend-words]
# <typo> = "<correction>"
[default.extend-identifiers]
# <typo> = "<correction>"
[type.NAME]
extend-glob = []
@@ -179,7 +181,9 @@ Custom uncorrectable sections (e.g. markdown code fences, PGP signatures, etc)
- Type: table of strings
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.
Map [identifier](./design.md#identifiers-and-words) typos to their corrections.
When the correction is blank, the identifier is never valid.
When the correction is the key, the identifier is always valid.
Example:
```toml
@@ -201,7 +205,9 @@ Pattern-match always-valid identifiers.
- Type: table of strings
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.
Map [word](./design.md#identifiers-and-words) typos to their corrections.
When the correction is blank, the word is never valid.
When the correction is the key, the word is always valid.
Example:
```toml