From 06305606f9d840610487a9b7dff9a159a05fb8d1 Mon Sep 17 00:00:00 2001 From: Michael Suo Date: Mon, 18 Apr 2022 10:41:59 -0700 Subject: [PATCH] docs: improve help message --- src/main.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/main.rs b/src/main.rs index b60a53e..2663b1b 100644 --- a/src/main.rs +++ b/src/main.rs @@ -30,7 +30,7 @@ struct Args { /// Shell command that returns new-line separated paths to lint /// - /// Example: --paths-cmd 'git ls-files path/to/project' + /// Example: To run on all files in the repo, use `--paths-cmd='git grep -Il .'`. #[clap(long, conflicts_with = "paths-from")] paths_cmd: Option, @@ -69,7 +69,9 @@ struct Args { #[clap(subcommand)] cmd: Option, - /// Paths to lint. + /// Paths to lint. lintrunner will still respect the inclusions and + /// exclusions defined in .lintrunner.toml; manually specifying a path will + /// not override them. #[clap(conflicts_with_all = &["paths-cmd", "paths-from"])] paths: Vec,