From 39b2b2639adec3f1e3012ae0beca7e5a8db29a1d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6ran=20Karl?=
 <3951388+JoeKar@users.noreply.github.com>
Date: Wed, 16 Oct 2024 20:47:42 +0200
Subject: [PATCH] action/command: Precise `HelpCmd()` documentation

---
 internal/action/command.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/internal/action/command.go b/internal/action/command.go
index 13d9f1b2..f5fdfffb 100644
--- a/internal/action/command.go
+++ b/internal/action/command.go
@@ -448,7 +448,10 @@ func (h *BufPane) openHelp(page string, hsplit bool, forceSplit bool) error {
 	return nil
 }
 
-// HelpCmd tries to open the given help page in a horizontal split
+// HelpCmd tries to open the given help page according to the split type
+// configured with the "helpsplit" option. It can be overriden by the optional
+// arguments "-vpslit" or "-hsplit". In case more than one help page is given
+// as argument then it opens all of them with the defined split type.
 func (h *BufPane) HelpCmd(args []string) {
 	hsplit := config.GlobalSettings["helpsplit"] == "hsplit"
 	if len(args) < 1 {