From 1864d838d9f5b43462098c8867692fd01564dfcd Mon Sep 17 00:00:00 2001 From: tahamahmoud7097-wq Date: Tue, 3 Feb 2026 17:44:46 +0200 Subject: [PATCH] Docs: Make updated docs clearer --- contrib/completions/_zoxide | 4 ++-- contrib/completions/_zoxide.ps1 | 4 ++-- contrib/completions/zoxide.elv | 4 ++-- contrib/completions/zoxide.fish | 2 +- contrib/completions/zoxide.nu | 2 +- contrib/completions/zoxide.ts | 2 +- src/cmd/cmd.rs | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/contrib/completions/_zoxide b/contrib/completions/_zoxide index 861a95c..bd1694b 100644 --- a/contrib/completions/_zoxide +++ b/contrib/completions/_zoxide @@ -32,8 +32,8 @@ _zoxide() { _arguments "${_arguments_options[@]}" : \ '-s+[The rank to increment the entry if it exists or initialize it with if it doesn'\''t]:SCORE:_default' \ '--score=[The rank to increment the entry if it exists or initialize it with if it doesn'\''t]:SCORE:_default' \ -'-a+[The alias for the entry to initialize without and then set afterwards or initialize with it]:ALIAS:_default' \ -'--alias=[The alias for the entry to initialize without and then set afterwards or initialize with it]:ALIAS:_default' \ +'-a+[The alias for the entry to initialize the entry with You can set a new alias after initialization]:ALIAS:_default' \ +'--alias=[The alias for the entry to initialize the entry with You can set a new alias after initialization]:ALIAS:_default' \ '-h[Print help]' \ '--help[Print help]' \ '-V[Print version]' \ diff --git a/contrib/completions/_zoxide.ps1 b/contrib/completions/_zoxide.ps1 index 7cb4c2e..0c93f0e 100644 --- a/contrib/completions/_zoxide.ps1 +++ b/contrib/completions/_zoxide.ps1 @@ -36,8 +36,8 @@ Register-ArgumentCompleter -Native -CommandName 'zoxide' -ScriptBlock { 'zoxide;add' { [CompletionResult]::new('-s', '-s', [CompletionResultType]::ParameterName, 'The rank to increment the entry if it exists or initialize it with if it doesn''t') [CompletionResult]::new('--score', '--score', [CompletionResultType]::ParameterName, 'The rank to increment the entry if it exists or initialize it with if it doesn''t') - [CompletionResult]::new('-a', '-a', [CompletionResultType]::ParameterName, 'The alias for the entry to initialize without and then set afterwards or initialize with it') - [CompletionResult]::new('--alias', '--alias', [CompletionResultType]::ParameterName, 'The alias for the entry to initialize without and then set afterwards or initialize with it') + [CompletionResult]::new('-a', '-a', [CompletionResultType]::ParameterName, 'The alias for the entry to initialize the entry with You can set a new alias after initialization') + [CompletionResult]::new('--alias', '--alias', [CompletionResultType]::ParameterName, 'The alias for the entry to initialize the entry with You can set a new alias after initialization') [CompletionResult]::new('-h', '-h', [CompletionResultType]::ParameterName, 'Print help') [CompletionResult]::new('--help', '--help', [CompletionResultType]::ParameterName, 'Print help') [CompletionResult]::new('-V', '-V ', [CompletionResultType]::ParameterName, 'Print version') diff --git a/contrib/completions/zoxide.elv b/contrib/completions/zoxide.elv index 53fec8d..482211d 100644 --- a/contrib/completions/zoxide.elv +++ b/contrib/completions/zoxide.elv @@ -32,8 +32,8 @@ set edit:completion:arg-completer[zoxide] = {|@words| &'zoxide;add'= { cand -s 'The rank to increment the entry if it exists or initialize it with if it doesn''t' cand --score 'The rank to increment the entry if it exists or initialize it with if it doesn''t' - cand -a 'The alias for the entry to initialize without and then set afterwards or initialize with it' - cand --alias 'The alias for the entry to initialize without and then set afterwards or initialize with it' + cand -a 'The alias for the entry to initialize the entry with You can set a new alias after initialization' + cand --alias 'The alias for the entry to initialize the entry with You can set a new alias after initialization' cand -h 'Print help' cand --help 'Print help' cand -V 'Print version' diff --git a/contrib/completions/zoxide.fish b/contrib/completions/zoxide.fish index 40cdb9c..221ea40 100644 --- a/contrib/completions/zoxide.fish +++ b/contrib/completions/zoxide.fish @@ -33,7 +33,7 @@ complete -c zoxide -n "__fish_zoxide_needs_command" -f -a "init" -d 'Generate sh complete -c zoxide -n "__fish_zoxide_needs_command" -f -a "query" -d 'Search for a directory in the database' complete -c zoxide -n "__fish_zoxide_needs_command" -f -a "remove" -d 'Remove a directory from the database' complete -c zoxide -n "__fish_zoxide_using_subcommand add" -s s -l score -d 'The rank to increment the entry if it exists or initialize it with if it doesn\'t' -r -complete -c zoxide -n "__fish_zoxide_using_subcommand add" -s a -l alias -d 'The alias for the entry to initialize without and then set afterwards or initialize with it' -r +complete -c zoxide -n "__fish_zoxide_using_subcommand add" -s a -l alias -d 'The alias for the entry to initialize the entry with You can set a new alias after initialization' -r complete -c zoxide -n "__fish_zoxide_using_subcommand add" -s h -l help -d 'Print help' complete -c zoxide -n "__fish_zoxide_using_subcommand add" -s V -l version -d 'Print version' complete -c zoxide -n "__fish_zoxide_using_subcommand edit; and not __fish_seen_subcommand_from decrement delete increment reload" -s h -l help -d 'Print help' diff --git a/contrib/completions/zoxide.nu b/contrib/completions/zoxide.nu index 36c5aac..95b8c30 100644 --- a/contrib/completions/zoxide.nu +++ b/contrib/completions/zoxide.nu @@ -10,7 +10,7 @@ module completions { export extern "zoxide add" [ ...paths: path --score(-s): string # The rank to increment the entry if it exists or initialize it with if it doesn't - --alias(-a): string # The alias for the entry to initialize without and then set afterwards or initialize with it + --alias(-a): string # The alias for the entry to initialize the entry with You can set a new alias after initialization --help(-h) # Print help --version(-V) # Print version ] diff --git a/contrib/completions/zoxide.ts b/contrib/completions/zoxide.ts index 3c5c861..06e5aee 100644 --- a/contrib/completions/zoxide.ts +++ b/contrib/completions/zoxide.ts @@ -17,7 +17,7 @@ const completion: Fig.Spec = { }, { name: ["-a", "--alias"], - description: "The alias for the entry to initialize without and then set afterwards or initialize with it", + description: "The alias for the entry to initialize the entry with You can set a new alias after initialization", isRepeatable: true, args: { name: "alias", diff --git a/src/cmd/cmd.rs b/src/cmd/cmd.rs index 4e41c50..3146cf0 100644 --- a/src/cmd/cmd.rs +++ b/src/cmd/cmd.rs @@ -64,7 +64,7 @@ pub struct Add { #[clap(short, long)] pub score: Option, - /// The alias for the entry to initialize with + /// The alias for the entry to initialize the entry with /// You can set a new alias after initialization #[clap(short, long)] pub alias: Option,