Skip to content

Commit

Permalink
cmd: Improve help message
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring committed Sep 11, 2023
1 parent 89a4d79 commit 2e8c527
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ const (
var rootCmd = &cobra.Command{
Use: appName,
Short: "Hugo Version Manager",
Long: `Hugo Version Manager (` + appName + `) allows you to download multiple versions of the
extended edition of the Hugo static site generator, and to specify which
version to use in the current directory.
Long: `Hugo Version Manager (` + appName + `) allows you to download and manage multiple versions
of the extended edition of the Hugo static site generator. You can use hvm to
specify which version of Hugo to use in the current directory.
If you do not specify a version to use in the current directory, the path to
the hugo executable is determined by the PATH environment variable.
If you do not specify a version of Hugo to use in the current directory, the
Hugo executable will be found by searching the PATH environment variable.
`,
Version: versionString,
}
Expand Down
10 changes: 5 additions & 5 deletions cmd/testscripts/hvm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
[windows] env AppData=config

exec hvm
stdout 'Hugo Version Manager \(hvm\) allows you to download multiple versions of the\n'
stdout 'extended edition of the Hugo static site generator, and to specify which\n'
stdout 'version to use in the current directory.\n\n'
stdout 'If you do not specify a version to use in the current directory, the path to\n'
stdout 'the hugo executable is determined by the PATH environment variable.\n'
stdout 'Hugo Version Manager \(hvm\) allows you to download and manage multiple versions\n'
stdout 'of the extended edition of the Hugo static site generator. You can use hvm to\n'
stdout 'specify which version of Hugo to use in the current directory.\n\n'
stdout 'If you do not specify a version of Hugo to use in the current directory, the\n'
stdout 'Hugo executable will be found by searching the PATH environment variable.\n'
stdout 'clean\s+Clean the cache\n'
stdout 'completion\s+Generate the autocompletion script for the specified shell\n'
stdout 'config\s+Display the current configuration\n'
Expand Down
2 changes: 1 addition & 1 deletion cmd/testscripts/hvm_help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@

# Test
exec hvm help
stdout 'Hugo Version Manager \(hvm\) allows you to download multiple versions of the\n'
stdout 'Hugo Version Manager \(hvm\) allows you to download and manage multiple versions\n'

0 comments on commit 2e8c527

Please sign in to comment.