Fix rendering issue in "formatting" help topic (cli#4661)

pbnj · web-flow · commit 175da0f58ae6 · 2021-11-02T17:30:49.000Z
Signed-off-by: Peter Benjamin &lt;petermbenjamin@gmail.com&gt;
diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go
@@ -2,6 +2,7 @@ package root
 
 import (
 	"github.com/MakeNowJust/heredoc"
+	"github.com/cli/cli/v2/pkg/text"
 	"github.com/spf13/cobra"
 )
 
@@ -104,31 +105,32 @@ var HelpTopics = map[string]map[string]string{
 			- %[1]stimeago <time>%[1]s: renders a timestamp as relative to now
 			- %[1]stimefmt <format> <time>%[1]s: formats a timestamp using Go's Time.Format function
 			- %[1]struncate <length> <input>%[1]s: ensures input fits within length
+		`, "`"),
+		"example": heredoc.Doc(`
+			# format issues as table
+			$ gh issue list --json number,title --template \
+			  '{{range .}}{{tablerow (printf "#%v" .number | autocolor "green") .title}}{{end}}'
 
-			EXAMPLES
-			  # format issues as table
-			  $ gh issue list --json number,title --template \
-			    '{{range .}}{{tablerow (printf "#%%v" .number | autocolor "green") .title}}{{end}}'
-			
-			  # format a pull request using multiple tables with headers
-			  $ gh pr view 3519 --json number,title,body,reviews,assignees --template \
-			    '{{printf "#%%v" .number}} {{.title}}
+			# format a pull request using multiple tables with headers
+			$ gh pr view 3519 --json number,title,body,reviews,assignees --template \
+			  '{{printf "#%v" .number}} {{.title}}
 
-			    {{.body}}
+			  {{.body}}
 
-			    {{tablerow "ASSIGNEE" "NAME"}}{{range .assignees}}{{tablerow .login .name}}{{end}}{{tablerender}}
-			    {{tablerow "REVIEWER" "STATE" "COMMENT"}}{{range .reviews}}{{tablerow .author.login .state .body}}{{end}}
-			    '
-		`, "`"),
+			  {{tablerow "ASSIGNEE" "NAME"}}{{range .assignees}}{{tablerow .login .name}}{{end}}{{tablerender}}
+			  {{tablerow "REVIEWER" "STATE" "COMMENT"}}{{range .reviews}}{{tablerow .author.login .state .body}}{{end}}
+			  '
+		`),
 	},
 }
 
 func NewHelpTopic(topic string) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:    topic,
-		Short:  HelpTopics[topic]["short"],
-		Long:   HelpTopics[topic]["long"],
-		Hidden: true,
+		Use:     topic,
+		Short:   HelpTopics[topic]["short"],
+		Long:    HelpTopics[topic]["long"],
+		Example: HelpTopics[topic]["example"],
+		Hidden:  true,
 		Annotations: map[string]string{
 			"markdown:generate": "true",
 			"markdown:basename": "gh_help_" + topic,
@@ -143,6 +145,10 @@ func NewHelpTopic(topic string) *cobra.Command {
 
 func helpTopicHelpFunc(command *cobra.Command, args []string) {
 	command.Print(command.Long)
+	if command.Example != "" {
+		command.Printf("\n\nEXAMPLES\n")
+		command.Print(text.Indent(command.Example, "  "))
+	}
 }
 
 func helpTopicUsageFunc(command *cobra.Command) error {
