Skip to content

Commit 0630560

Browse files
committed
docs: improve help message
1 parent 0241c01 commit 0630560

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/main.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ struct Args {
3030

3131
/// Shell command that returns new-line separated paths to lint
3232
///
33-
/// Example: --paths-cmd 'git ls-files path/to/project'
33+
/// Example: To run on all files in the repo, use `--paths-cmd='git grep -Il .'`.
3434
#[clap(long, conflicts_with = "paths-from")]
3535
paths_cmd: Option<String>,
3636

@@ -69,7 +69,9 @@ struct Args {
6969
#[clap(subcommand)]
7070
cmd: Option<SubCommand>,
7171

72-
/// Paths to lint.
72+
/// Paths to lint. lintrunner will still respect the inclusions and
73+
/// exclusions defined in .lintrunner.toml; manually specifying a path will
74+
/// not override them.
7375
#[clap(conflicts_with_all = &["paths-cmd", "paths-from"])]
7476
paths: Vec<String>,
7577

0 commit comments

Comments
 (0)