From 3464de21149d8a064f7ff1b618c5ee50b5efea45 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Thu, 10 Apr 2025 11:06:50 -0500 Subject: [PATCH] docs(cli): Clarify '-' behavior Fixes #1271 --- crates/typos-cli/src/bin/typos-cli/args.rs | 2 +- crates/typos-cli/tests/cmd/help.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/typos-cli/src/bin/typos-cli/args.rs b/crates/typos-cli/src/bin/typos-cli/args.rs index 2ca24ad7..debd10a2 100644 --- a/crates/typos-cli/src/bin/typos-cli/args.rs +++ b/crates/typos-cli/src/bin/typos-cli/args.rs @@ -30,7 +30,7 @@ impl Format { #[command(about, author, version)] #[command(group = clap::ArgGroup::new("mode").multiple(false))] pub(crate) struct Args { - /// Paths to check with `-` for stdin + /// Paths to check (`-` to check stdin) #[arg(default_value = ".", group = "source")] pub(crate) path: Vec, diff --git a/crates/typos-cli/tests/cmd/help.toml b/crates/typos-cli/tests/cmd/help.toml index 72f87d85..009f6cf2 100644 --- a/crates/typos-cli/tests/cmd/help.toml +++ b/crates/typos-cli/tests/cmd/help.toml @@ -6,7 +6,7 @@ Source Code Spelling Correction Usage: typos[EXE] [OPTIONS] [PATH]... Arguments: - [PATH]... Paths to check with `-` for stdin [default: .] + [PATH]... Paths to check (`-` to check stdin) [default: .] Options: --file-list Read the list of newline separated paths from file or stdin (if `-`)