docs: Fix source precedence

This commit is contained in:
Ed Page 2019-10-25 09:39:55 -06:00 committed by GitHub
parent 5863158a31
commit 52926d8cd1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -7,23 +7,22 @@
Configuration is read from the following (in precedence order) Configuration is read from the following (in precedence order)
- Command line arguments - Command line arguments
- Either - File specified via `--config PATH`
- File specified via `--config PATH` - Search parents of specified file / directory for `typos.toml`
- Search parents of specified file / directory for `typos.toml`
### Config Fields ### Config Fields
| Field | Argument | Format | Description | | Field | Argument | Format | Description |
|------------------------|-------------------|--------|-------------| |------------------------|-------------------|--------|-------------|
| files.binary | --binary | bool | | | files.binary | --binary | bool | |
| files.ignore-hidden | --hidden | bool | | | files.ignore-hidden | --hidden | bool | |
| files.ignore-files | --ignore | bool | | | files.ignore-files | --ignore | bool | |
| files.ignore-dot | --ignore-dot | bool | | | files.ignore-dot | --ignore-dot | bool | |
| files.ignore-vcs | --ignore-vcs | bool | | | files.ignore-vcs | --ignore-vcs | bool | |
| files.ignore-global | --ignore-global | bool | | | files.ignore-global | --ignore-global | bool | |
| files.ignore-parent | --ignore-parent | bool | | | files.ignore-parent | --ignore-parent | bool | |
| default.check-filename | \- | bool | | | default.check-filename | \- | bool | |
| default.check-file | \- | bool | | | default.check-file | \- | bool | |
| default.ignore-hex | \- | bool | | | default.ignore-hex | \- | bool | |
| default.identifier-include-digits | \- | bool | | | default.identifier-include-digits | \- | bool | |
| default.identifier-include-chars | \- | string | | | default.identifier-include-chars | \- | string | |