From e319aaa6abc1fc9338570d77d9c6ab65bc1567f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 7 Jul 2020 12:21:25 +0200 Subject: [PATCH] Tweak `pr merge` docs --- command/pr.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/command/pr.go b/command/pr.go index e11884bbb..0c851b511 100644 --- a/command/pr.go +++ b/command/pr.go @@ -107,13 +107,14 @@ var prReopenCmd = &cobra.Command{ } var prMergeCmd = &cobra.Command{ Use: "merge [ | | ]", - Args: cobra.MaximumNArgs(1), Short: "Merge a pull request", - Long: `Merge a pull request by providing the pull request number or url or the branch. + Long: heredoc.Doc(` + Merge a pull request on GitHub. -By default, the source branch gets deleted after the pull request merge is complete. - -If the source branch needs be retained, '--delete-branch=false' should be specified.`, + By default, the head branch of the pull request will get deleted on both remote and local repositories. + To retain the branch, use '--delete-branch=false'. + `), + Args: cobra.MaximumNArgs(1), RunE: prMerge, } var prReadyCmd = &cobra.Command{