fix(cli): Align docs phrasing and capitalization

This commit is contained in:
Pascal Hertleif 2025-02-12 11:04:54 +01:00 committed by João Marcos
parent f3b7c0277f
commit fadfe1a213
3 changed files with 15 additions and 15 deletions

View File

@ -25,15 +25,15 @@ pub struct CliArgs {
#[arg(short = 'A', long, env = "ACCESSIBLE", global = true)] #[arg(short = 'A', long, env = "ACCESSIBLE", global = true)]
pub accessible: bool, pub accessible: bool,
/// Ignores hidden files /// Ignore hidden files
#[arg(short = 'H', long, global = true)] #[arg(short = 'H', long, global = true)]
pub hidden: bool, pub hidden: bool,
/// Silences output /// Silence output
#[arg(short = 'q', long, global = true)] #[arg(short = 'q', long, global = true)]
pub quiet: bool, pub quiet: bool,
/// Ignores files matched by git's ignore files /// Ignore files matched by git's ignore files
#[arg(short = 'g', long, global = true)] #[arg(short = 'g', long, global = true)]
pub gitignore: bool, pub gitignore: bool,
@ -41,11 +41,11 @@ pub struct CliArgs {
#[arg(short, long, global = true)] #[arg(short, long, global = true)]
pub format: Option<OsString>, pub format: Option<OsString>,
/// decompress or list with password /// Decompress or list with password
#[arg(short = 'p', long = "password", global = true)] #[arg(short = 'p', long = "password", global = true)]
pub password: Option<OsString>, pub password: Option<OsString>,
/// concurrent working threads /// Concurrent working threads
#[arg(short = 'c', long, global = true)] #[arg(short = 'c', long, global = true)]
pub threads: Option<usize>, pub threads: Option<usize>,

View File

@ -17,11 +17,11 @@ Options:
-y, --yes Skip [Y/n] questions positively -y, --yes Skip [Y/n] questions positively
-n, --no Skip [Y/n] questions negatively -n, --no Skip [Y/n] questions negatively
-A, --accessible Activate accessibility mode, reducing visual noise [env: ACCESSIBLE=] -A, --accessible Activate accessibility mode, reducing visual noise [env: ACCESSIBLE=]
-H, --hidden Ignores hidden files -H, --hidden Ignore hidden files
-q, --quiet Silences output -q, --quiet Silence output
-g, --gitignore Ignores files matched by git's ignore files -g, --gitignore Ignore files matched by git's ignore files
-f, --format <FORMAT> Specify the format of the archive -f, --format <FORMAT> Specify the format of the archive
-p, --password <PASSWORD> decompress or list with password -p, --password <PASSWORD> Decompress or list with password
-c, --threads <THREADS> concurrent working threads -c, --threads <THREADS> Concurrent working threads
-h, --help Print help (see more with '--help') -h, --help Print help (see more with '--help')
-V, --version Print version -V, --version Print version

View File

@ -30,22 +30,22 @@ Options:
[env: ACCESSIBLE=] [env: ACCESSIBLE=]
-H, --hidden -H, --hidden
Ignores hidden files Ignore hidden files
-q, --quiet -q, --quiet
Silences output Silence output
-g, --gitignore -g, --gitignore
Ignores files matched by git's ignore files Ignore files matched by git's ignore files
-f, --format <FORMAT> -f, --format <FORMAT>
Specify the format of the archive Specify the format of the archive
-p, --password <PASSWORD> -p, --password <PASSWORD>
decompress or list with password Decompress or list with password
-c, --threads <THREADS> -c, --threads <THREADS>
concurrent working threads Concurrent working threads
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')