From ed8e25700cc01f026a8856c41749102dc787d8a2 Mon Sep 17 00:00:00 2001 From: dosisod <39638017+dosisod@users.noreply.github.com> Date: Fri, 8 Sep 2023 10:26:20 -0700 Subject: [PATCH] docs: Document new `pyproject.toml` support --- docs/reference.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/reference.md b/docs/reference.md index 5ea0ce5..4b7e792 100644 --- 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