Skip to content

Commit 39b2b26

Browse files
committed
action/command: Precise HelpCmd() documentation
1 parent 47b84f7 commit 39b2b26

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

internal/action/command.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,10 @@ func (h *BufPane) openHelp(page string, hsplit bool, forceSplit bool) error {
448448
return nil
449449
}
450450

451-
// HelpCmd tries to open the given help page in a horizontal split
451+
// HelpCmd tries to open the given help page according to the split type
452+
// configured with the "helpsplit" option. It can be overriden by the optional
453+
// arguments "-vpslit" or "-hsplit". In case more than one help page is given
454+
// as argument then it opens all of them with the defined split type.
452455
func (h *BufPane) HelpCmd(args []string) {
453456
hsplit := config.GlobalSettings["helpsplit"] == "hsplit"
454457
if len(args) < 1 {

0 commit comments

Comments
 (0)