doc: adjust the help text

abhinav · Feb 3, 2025 · 1a2a8cd · 1a2a8cd
1 parent 34338db
commit 1a2a8cd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/branch_squash.go b/branch_squash.go
@@ -24,6 +24,9 @@ func (*branchSquashCmd) Help() string {
 	return text.Dedent(`
 		Squash all commits in the current branch into a single commit
 		and restack upstack branches.
+
+		An editor will open to edit the commit message of the squashed commit.
+		Use the -m/--message flag to specify a commit message without editing.
 	`)
 }
 

diff --git a/doc/includes/cli-reference.md b/doc/includes/cli-reference.md
@@ -653,6 +653,9 @@ Squash a branch into one commit
 Squash all commits in the current branch into a single commit
 and restack upstack branches.
 
+An editor will open to edit the commit message of the squashed commit.
+Use the -m/--message flag to specify a commit message without editing.
+
 **Flags**
 
 * `--no-verify`: Bypass pre-commit and commit-msg hooks.