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

Document new `pyproject.toml` support
crate-ci · Sep 8, 2023 · da27591 · da27591
2 parents 74d959b + ed8e257
commit da27591
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/reference.md b/docs/reference.md
@@ -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