Merge pull request #826 from dosisod/document-pyproject-toml

Document new `pyproject.toml` support
This commit is contained in:
Ed Page authored and GitHub committed 2023-09-08 12:57:06 -05:00
commit da2759161f
1 file changed
+3 -1
+3 -1
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