From cf5a21a72518e30e110bfc1789e1ec5d2f5342d0 Mon Sep 17 00:00:00 2001
From: Ayman Bagabas <ayman.bagabas@gmail.com>
Date: Wed, 24 Apr 2024 21:52:38 +0300
Subject: [PATCH] Update commands.go

Co-authored-by: Christian Rocha <christian@rocha.is>
---
 commands.go | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/commands.go b/commands.go
index c37c660bd5..3fe4aa1b22 100644
--- a/commands.go
+++ b/commands.go
@@ -194,7 +194,11 @@ func SetWindowTitle(title string) Cmd {
 
 type windowSizeMsg struct{}
 
-// WindowSize is a command that queries the terminal for its current size.
+// WindowSize is a command that queries the terminal for its current size. It
+// delivers the results to Update via a [WindowSizeMsg]. Keep in mind that
+// WindowSizeMsgs will automatically be delivered to Update when the [Program]
+// starts and when the window dimensions change so in many cases you will not
+// need to explicitly invoke this command.
 func WindowSize() Cmd {
 	return func() Msg {
 		return windowSizeMsg{}