Skip to content

Commit

Permalink
Completion: Capitalize short desc, and remove extra space from long (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
fcjr authored Dec 7, 2021
1 parent dd40ab0 commit c3573e2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 14 deletions.
19 changes: 7 additions & 12 deletions completions.go
Original file line number Diff line number Diff line change
Expand Up @@ -599,9 +599,8 @@ func (c *Command) initDefaultCompletionCmd() {

completionCmd := &Command{
Use: compCmdName,
Short: "generate the autocompletion script for the specified shell",
Long: fmt.Sprintf(`
Generate the autocompletion script for %[1]s for the specified shell.
Short: "Generate the autocompletion script for the specified shell",
Long: fmt.Sprintf(`Generate the autocompletion script for %[1]s for the specified shell.
See each sub-command's help for details on how to use the generated script.
`, c.Root().Name()),
Args: NoArgs,
Expand All @@ -611,12 +610,11 @@ See each sub-command's help for details on how to use the generated script.

out := c.OutOrStdout()
noDesc := c.CompletionOptions.DisableDescriptions
shortDesc := "generate the autocompletion script for %s"
shortDesc := "Generate the autocompletion script for %s"
bash := &Command{
Use: "bash",
Short: fmt.Sprintf(shortDesc, "bash"),
Long: fmt.Sprintf(`
Generate the autocompletion script for the bash shell.
Long: fmt.Sprintf(`Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
Expand Down Expand Up @@ -651,8 +649,7 @@ You will need to start a new shell for this setup to take effect.
zsh := &Command{
Use: "zsh",
Short: fmt.Sprintf(shortDesc, "zsh"),
Long: fmt.Sprintf(`
Generate the autocompletion script for the zsh shell.
Long: fmt.Sprintf(`Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
Expand Down Expand Up @@ -687,8 +684,7 @@ You will need to start a new shell for this setup to take effect.
fish := &Command{
Use: "fish",
Short: fmt.Sprintf(shortDesc, "fish"),
Long: fmt.Sprintf(`
Generate the autocompletion script for the fish shell.
Long: fmt.Sprintf(`Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
Expand All @@ -713,8 +709,7 @@ You will need to start a new shell for this setup to take effect.
powershell := &Command{
Use: "powershell",
Short: fmt.Sprintf(shortDesc, "powershell"),
Long: fmt.Sprintf(`
Generate the autocompletion script for powershell.
Long: fmt.Sprintf(`Generate the autocompletion script for powershell.
To load completions in your current shell session:
Expand Down
4 changes: 2 additions & 2 deletions completions_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ func TestCmdNameCompletionInGo(t *testing.T) {

expected = strings.Join([]string{
"aliased\tA command with aliases",
"completion\tgenerate the autocompletion script for the specified shell",
"completion\tGenerate the autocompletion script for the specified shell",
"firstChild\tFirst command",
"help\tHelp about any command",
"secondChild",
Expand Down Expand Up @@ -580,7 +580,7 @@ func TestFlagNameCompletionInGoWithDesc(t *testing.T) {

expected := strings.Join([]string{
"childCmd\tfirst command",
"completion\tgenerate the autocompletion script for the specified shell",
"completion\tGenerate the autocompletion script for the specified shell",
"help\tHelp about any command",
":4",
"Completion ended with directive: ShellCompDirectiveNoFileComp", ""}, "\n")
Expand Down

0 comments on commit c3573e2

Please sign in to comment.