From 1a2a8cdf4943d9a1f93ff89a52f245e891c63e40 Mon Sep 17 00:00:00 2001
From: Abhinav Gupta <mail@abhinavg.net>
Date: Sun, 2 Feb 2025 20:16:05 -0800
Subject: [PATCH] doc: adjust the help text

---
 branch_squash.go              | 3 +++
 doc/includes/cli-reference.md | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/branch_squash.go b/branch_squash.go
index df676a9..6dd80c5 100644
--- 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
index dc5502d..e48fcaa 100644
--- 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.