fix: show subcommand info in short help if there are any

- only invite the user to check help for subcommands if there are any - invite the user to check out the LongHelp for this command with --help License: MIT Signed-off-by: Oli Evans <[email protected]>
ipfs · Oct 22, 2020 · 8025471 · 8025471
1 parent b0de627
commit 8025471
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/cli/helptext.go b/cli/helptext.go
@@ -110,9 +110,11 @@ const shortHelpFormat = `USAGE
 {{end}}{{if .Subcommands}}
 SUBCOMMANDS
 {{.Subcommands}}
-{{end}}{{if .MoreHelp}}
 {{.Indent}}For more information about each command, use:
 {{.Indent}}'{{.Path}} <subcmd> --help'
+{{end}}{{if .MoreHelp}}
+{{.Indent}}for more information about this command, use:
+{{.Indent}}'{{.Path}} --help'
 {{end}}
 `
 

diff --git a/cli/helptext_test.go b/cli/helptext_test.go
@@ -48,9 +48,6 @@ func TestSynopsisGenerator(t *testing.T) {
 	if !strings.Contains(syn, "[--]") {
 		t.Fatal("Synopsis should contain options finalizer")
 	}
-	if strings.Contains(syn, "For more information about each command") {
-		t.Fatal("Synopsis should not contain subcommands")
-	}
 }
 
 func TestShortHelp(t *testing.T) {