Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CLI documentation for fixes

This commit is contained in:
Zanie 2023-10-02 20:14:57 -05:00
parent 74acdf5a22
commit 85b5efe141
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/ruff_cli/src/args.rs
View File

@ -76,11 +76,11 @@ pub enum Command {
pub struct CheckCommand { pub struct CheckCommand {
/// List of files or directories to check. /// List of files or directories to check.
pub files: Vec<PathBuf>, pub files: Vec<PathBuf>,
/// Attempt to automatically fix lint violations. /// Apply automatic fixes to resolve lint violations.
/// Use `--no-fix` to disable. /// Use `--no-fix` to disable or `--fix-suggested` to include suggested fixes.
#[arg(long, overrides_with("no_fix"))] #[arg(long, overrides_with("no_fix"))]
fix: bool, 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"]))] #[arg(long, overrides_with_all(["fix", "no_fix"]))]
fix_suggested: bool, fix_suggested: bool,
#[clap(long, overrides_with_all(["fix", "fix_suggested"]), hide = true)] #[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. /// Run in watch mode by re-running whenever files change.
#[arg(short, long)] #[arg(short, long)]
pub watch: bool, pub watch: bool,
/// Fix any fixable lint violations, but don't report on leftover violations. Implies `--fix`. /// Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`.
/// Use `--no-fix-only` to disable. /// Use `--no-fix-only` to disable or `--fix-suggested` to include suggested fixes.
#[arg(long, overrides_with("no_fix_only"))] #[arg(long, overrides_with("no_fix_only"))]
fix_only: bool, fix_only: bool,
#[clap(long, overrides_with("fix_only"), hide = true)] #[clap(long, overrides_with("fix_only"), hide = true)]

6
docs/configuration.md
View File

@ -193,9 +193,9 @@ Arguments:
Options: Options:
--fix --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 --fix-suggested
Attempt to automatically fix both automatic and suggested lint violations Apply automatic and suggested fixes to resolve lint violations
--show-source --show-source
Show violations with source code. Use `--no-show-source` to disable Show violations with source code. Use `--no-show-source` to disable
--show-fixes --show-fixes
@ -205,7 +205,7 @@ Options:
-w, --watch -w, --watch
Run in watch mode by re-running whenever files change Run in watch mode by re-running whenever files change
--fix-only --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-noqa
Ignore any `# noqa` comments Ignore any `# noqa` comments
--output-format <OUTPUT_FORMAT> --output-format <OUTPUT_FORMAT>