From 240053aa961fad798694e5775e9c9474b4591908 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Thu, 25 Jul 2024 15:30:49 -0500 Subject: [PATCH] docs: Update changelog --- CHANGELOG.md | 4 ++++ docs/reference.md | 5 +++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 60701ca..3ee324b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] - ReleaseDate +### Features + +- *(config)* Store config in `Cargo.toml` + ## [1.23.4] - 2024-07-25 ### Fixes diff --git a/docs/reference.md b/docs/reference.md index ad27850..0e93cb7 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -8,9 +8,10 @@ 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`, `.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 +- Search parents of specified file / directory for one of `typos.toml`, `_typos.toml`, `.typos.toml`, `Cargo.toml`, or `pyproject.toml`. + - In `pyproject.toml`, the below fields must be under the `[tool.typos]` section. If this section does not exist, the config file will be skipped. + - In `Cargo.toml`, the below fields must be under either `[workspace.metadata.typos]` or `[package.metadata.typos]` ### Config Fields