actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 00:51:11 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Document new pyproject.toml support

Browse source
This commit is contained in:
dosisod 2023-09-08 10:26:20 -07:00
parent 74d959bf38
commit ed8e25700c
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/reference.md
View file

@ -8,7 +8,9 @@ Configuration is read from the following (in precedence order)
- Command line arguments
- File specified via `--config PATH`
- Search parents of specified file / directory for one of `typos.toml`, `_typos.toml`, or `.typos.toml`
- Search parents of specified file / directory for one of `typos.toml`, `_typos.toml`, `.typos.toml`, or `pyproject.toml`.
- In the case of `pyproject.toml`, the below fields must be under the `[tool.typos]` section. If this section does not
exist, the config file will be skipped.
### Config Fields