Skip to content

Commit

Permalink
Make short helps more consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Feb 14, 2020
1 parent 3259503 commit d847c8f
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion cmd/cat.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
var catCmd = &cobra.Command{
Use: "cat targets...",
Args: cobra.MinimumNArgs(1),
Short: "Write the target state of a file or symlink to stdout",
Short: "Print the target contents of a file or symlink",
Long: mustGetLongHelp("cat"),
Example: getExample("cat"),
PreRunE: config.ensureNoError,
Expand Down
2 changes: 1 addition & 1 deletion cmd/completion.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
var completionCmd = &cobra.Command{
Use: "completion shell",
Args: cobra.ExactArgs(1),
Short: "Output shell completion code for the specified shell (bash, fish, or zsh)",
Short: "Write shell completion code for the specified shell (bash, fish, or zsh) to stdout",
Long: mustGetLongHelp("completion"),
Example: getExample("completion"),
ValidArgs: []string{"bash", "fish", "zsh"},
Expand Down
2 changes: 1 addition & 1 deletion cmd/data.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type dataCmdConfig struct {
var dataCmd = &cobra.Command{
Use: "data",
Args: cobra.NoArgs,
Short: "Write the template data to stdout",
Short: "Print the template data",
Long: mustGetLongHelp("data"),
Example: getExample("data"),
PreRunE: config.ensureNoError,
Expand Down
2 changes: 1 addition & 1 deletion cmd/diff.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

var diffCmd = &cobra.Command{
Use: "diff [targets...]",
Short: "Write the diff between the target state and the destination state to stdout",
Short: "Print the diff between the target state and the destination state",
Long: mustGetLongHelp("diff"),
Example: getExample("diff"),
PreRunE: config.ensureNoError,
Expand Down
8 changes: 4 additions & 4 deletions completions/chezmoi.fish
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ end
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a add -d 'Add an existing file, directory, or symlink to the source state'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a apply -d 'Update the destination directory to match the target state'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a archive -d 'Write a tar archive of the target state to stdout'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a cat -d 'Write the target state of a file or symlink to stdout'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a cat -d 'Print the target contents of a file or symlink'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a cd -d 'Launch a shell in the source directory'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a chattr -d 'Change the attributes of a target in the source state'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a completion -d 'Output shell completion code for the specified shell (bash, fish, or zsh)'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a data -d 'Write the template data to stdout'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a diff -d 'Write the diff between the target state and the destination state to stdout'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a completion -d 'Write shell completion code for the specified shell (bash, fish, or zsh) to stdout'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a data -d 'Print the template data'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a diff -d 'Print the diff between the target state and the destination state'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a docs -d 'Print documentation'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a doctor -d 'Check your system for potential problems'
complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -a dump -d 'Write a dump of the target state to stdout'
Expand Down
8 changes: 4 additions & 4 deletions completions/chezmoi.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ function _chezmoi {
"add:Add an existing file, directory, or symlink to the source state"
"apply:Update the destination directory to match the target state"
"archive:Write a tar archive of the target state to stdout"
"cat:Write the target state of a file or symlink to stdout"
"cat:Print the target contents of a file or symlink"
"cd:Launch a shell in the source directory"
"chattr:Change the attributes of a target in the source state"
"completion:Output shell completion code for the specified shell (bash, fish, or zsh)"
"data:Write the template data to stdout"
"diff:Write the diff between the target state and the destination state to stdout"
"completion:Write shell completion code for the specified shell (bash, fish, or zsh) to stdout"
"data:Print the template data"
"diff:Print the diff between the target state and the destination state"
"docs:Print documentation"
"doctor:Check your system for potential problems"
"dump:Write a dump of the target state to stdout"
Expand Down

0 comments on commit d847c8f

Please sign in to comment.