Merge pull request #13632 from cli/babakks/fix-discussion-docs

babakks · web-flow · commit 57b9b207d900 · 2026-06-10T23:22:37.000+01:00
docs(discussion): polish help docs
diff --git a/pkg/cmd/discussion/create/create.go b/pkg/cmd/discussion/create/create.go
@@ -39,12 +39,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
 	cmd := &cobra.Command{
 		Use:   "create [flags]",
 		Short: "Create a new discussion (preview)",
-		Long: heredoc.Doc(`
+		Long: heredoc.Docf(`
 			Create a new GitHub Discussion in a repository.
 
-			With '--title', '--body', and '--category', a discussion is created non-interactively.
+			With %[1]s--title%[1]s, %[1]s--body%[1]s (or %[1]s--body-file%[1]s), and %[1]s--category%[1]s, a discussion is created non-interactively.
 			Omitting any of these flags triggers interactive prompts when connected to a terminal.
-		`),
+		`, "`"),
 		Example: heredoc.Doc(`
 			# Create interactively
 			$ gh discussion create
diff --git a/pkg/cmd/discussion/discussion.go b/pkg/cmd/discussion/discussion.go
@@ -21,7 +21,7 @@ func NewCmdDiscussion(f *cmdutil.Factory) *cobra.Command {
 		`),
 		Example: heredoc.Doc(`
 			$ gh discussion list
-			$ gh discussion create --category "General" --title "Hello"
+			$ gh discussion create --category "General" --title "Hello" --body "Hello World!"
 			$ gh discussion view 123
 		`),
 		Annotations: map[string]string{
