Docs: Make updated docs clearer
This commit is contained in:
parent
863aa179a4
commit
1864d838d9
|
|
@ -32,8 +32,8 @@ _zoxide() {
|
||||||
_arguments "${_arguments_options[@]}" : \
|
_arguments "${_arguments_options[@]}" : \
|
||||||
'-s+[The rank to increment the entry if it exists or initialize it with if it doesn'\''t]:SCORE:_default' \
|
'-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' \
|
'--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' \
|
'-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 without and then set afterwards or initialize with it]: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]' \
|
'-h[Print help]' \
|
||||||
'--help[Print help]' \
|
'--help[Print help]' \
|
||||||
'-V[Print version]' \
|
'-V[Print version]' \
|
||||||
|
|
|
||||||
|
|
@ -36,8 +36,8 @@ Register-ArgumentCompleter -Native -CommandName 'zoxide' -ScriptBlock {
|
||||||
'zoxide;add' {
|
'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('-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('--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('-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 without and then set afterwards or initialize with it')
|
[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('-h', '-h', [CompletionResultType]::ParameterName, 'Print help')
|
||||||
[CompletionResult]::new('--help', '--help', [CompletionResultType]::ParameterName, 'Print help')
|
[CompletionResult]::new('--help', '--help', [CompletionResultType]::ParameterName, 'Print help')
|
||||||
[CompletionResult]::new('-V', '-V ', [CompletionResultType]::ParameterName, 'Print version')
|
[CompletionResult]::new('-V', '-V ', [CompletionResultType]::ParameterName, 'Print version')
|
||||||
|
|
|
||||||
|
|
@ -32,8 +32,8 @@ set edit:completion:arg-completer[zoxide] = {|@words|
|
||||||
&'zoxide;add'= {
|
&'zoxide;add'= {
|
||||||
cand -s 'The rank to increment the entry if it exists or initialize it with if it doesn''t'
|
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 --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 -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 without and then set afterwards or initialize with it'
|
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 -h 'Print help'
|
||||||
cand --help 'Print help'
|
cand --help 'Print help'
|
||||||
cand -V 'Print version'
|
cand -V 'Print version'
|
||||||
|
|
|
||||||
|
|
@ -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 "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_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 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 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 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'
|
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'
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ module completions {
|
||||||
export extern "zoxide add" [
|
export extern "zoxide add" [
|
||||||
...paths: path
|
...paths: path
|
||||||
--score(-s): string # The rank to increment the entry if it exists or initialize it with if it doesn't
|
--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
|
--help(-h) # Print help
|
||||||
--version(-V) # Print version
|
--version(-V) # Print version
|
||||||
]
|
]
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@ const completion: Fig.Spec = {
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: ["-a", "--alias"],
|
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,
|
isRepeatable: true,
|
||||||
args: {
|
args: {
|
||||||
name: "alias",
|
name: "alias",
|
||||||
|
|
|
||||||
|
|
@ -64,7 +64,7 @@ pub struct Add {
|
||||||
#[clap(short, long)]
|
#[clap(short, long)]
|
||||||
pub score: Option<f64>,
|
pub score: Option<f64>,
|
||||||
|
|
||||||
/// 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
|
/// You can set a new alias after initialization
|
||||||
#[clap(short, long)]
|
#[clap(short, long)]
|
||||||
pub alias: Option<String>,
|
pub alias: Option<String>,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue