diff --git a/crates/ruff_cli/src/args.rs b/crates/ruff_cli/src/args.rs index f59cb623c6..acd797595f 100644 --- a/crates/ruff_cli/src/args.rs +++ b/crates/ruff_cli/src/args.rs @@ -76,11 +76,11 @@ pub enum Command { pub struct CheckCommand { /// List of files or directories to check. pub files: Vec, - /// Attempt to automatically fix lint violations. - /// Use `--no-fix` to disable. + /// Apply automatic fixes to resolve lint violations. + /// Use `--no-fix` to disable or `--fix-suggested` to include suggested fixes. #[arg(long, overrides_with("no_fix"))] fix: bool, - /// Attempt to automatically fix both automatic and suggested lint violations. + /// Apply automatic and suggested fixes to resolve lint violations. #[arg(long, overrides_with_all(["fix", "no_fix"]))] fix_suggested: bool, #[clap(long, overrides_with_all(["fix", "fix_suggested"]), hide = true)] @@ -103,8 +103,8 @@ pub struct CheckCommand { /// Run in watch mode by re-running whenever files change. #[arg(short, long)] pub watch: bool, - /// Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`. - /// Use `--no-fix-only` to disable. + /// Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`. + /// Use `--no-fix-only` to disable or `--fix-suggested` to include suggested fixes. #[arg(long, overrides_with("no_fix_only"))] fix_only: bool, #[clap(long, overrides_with("fix_only"), hide = true)] diff --git a/docs/configuration.md b/docs/configuration.md index dbe568dcc2..daab96b9a1 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -193,9 +193,9 @@ Arguments: Options: --fix - Attempt to automatically fix lint violations. Use `--no-fix` to disable + Apply automatic fixes to resolve lint violations. Use `--no-fix` to disable or `--fix-suggested` to include suggested fixes --fix-suggested - Attempt to automatically fix both automatic and suggested lint violations + Apply automatic and suggested fixes to resolve lint violations --show-source Show violations with source code. Use `--no-show-source` to disable --show-fixes @@ -205,7 +205,7 @@ Options: -w, --watch Run in watch mode by re-running whenever files change --fix-only - Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable + Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable or `--fix-suggested` to include suggested fixes --ignore-noqa Ignore any `# noqa` comments --output-format