Merge pull request #1186 from friday/patch-1
Some checks failed
Security audit / security_audit (push) Has been cancelled
Security audit / cargo_deny (bans licenses sources) (push) Has been cancelled
CI / Test (push) Has been cancelled
CI / Check MSRV (push) Has been cancelled
CI / lockfile (push) Has been cancelled
CI / Docs (push) Has been cancelled
CI / rustfmt (push) Has been cancelled
CI / clippy (push) Has been cancelled
CI / Coverage (push) Has been cancelled
/ linux (aarch64) (push) Has been cancelled
/ linux (x86) (push) Has been cancelled
/ linux (x86_64) (push) Has been cancelled
/ musllinux (aarch64) (push) Has been cancelled
/ musllinux (x86_64) (push) Has been cancelled
/ windows (x64) (push) Has been cancelled
/ windows (x86) (push) Has been cancelled
/ macos (aarch64) (push) Has been cancelled
/ macos (x86_64) (push) Has been cancelled
/ sdist (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
CI / CI (push) Has been cancelled
/ Release (push) Has been cancelled

docs: add linkable header to example configurations
This commit is contained in:
Ed Page 2024-12-19 16:28:57 -06:00 committed by GitHub
commit 6559554303
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -39,6 +39,8 @@ Configuration is read from the following (in precedence order)
| type.\<name>.\<field> | \<varied> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s. | | type.\<name>.\<field> | \<varied> | \<varied> | \<varied> | See `default.` for child keys. Run with `--type-list` to see available `<name>`s. |
| type.\<name>.extend-glob | \- | list of strings | \- | File globs for matching `<name>`. | | type.\<name>.extend-glob | \- | list of strings | \- | File globs for matching `<name>`. |
### Example configurations
Common `extend-ignore-re`: Common `extend-ignore-re`:
- Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"` - Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"`
- Line block with `# spellchecker:<on|off>`: `"(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"` - Line block with `# spellchecker:<on|off>`: `"(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"`