From 9867bbf9fe0f85bc61575deb8e5762e5bb12a9a4 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 15 Dec 2025 20:49:34 -0600 Subject: [PATCH] Update examples --- crates/ty_project/src/metadata/options.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/crates/ty_project/src/metadata/options.rs b/crates/ty_project/src/metadata/options.rs index 311f020dee..5bd73f28f4 100644 --- a/crates/ty_project/src/metadata/options.rs +++ b/crates/ty_project/src/metadata/options.rs @@ -1226,17 +1226,21 @@ pub struct TerminalOptions { /// An override allows you to apply different rule configurations to specific /// files or directories. Multiple overrides can match the same file, with /// later overrides take precedence. Override rules take precedence over global -/// rules for matching files +/// rules for matching files. +/// +/// For example, to relax enforcement of rules in test files: /// /// ```toml title="pyproject.toml" -/// # Relax rules for test files /// [[tool.ty.overrides]] /// include = ["tests/**", "**/test_*.py"] /// /// [tool.ty.overrides.rules] /// possibly-unresolved-reference = "warn" +/// ``` /// -/// # Ignore generated files but still check important ones +/// Or, to ignore a rule in generated files but retain enforcement in an important file: +/// +/// ```toml title="pyproject.toml" /// [[tool.ty.overrides]] /// include = ["generated/**"] /// exclude = ["generated/important.py"]