Function: hui:menu-doc

hui:menu-doc is a byte-compiled function defined in hui-mini.el.

Signature

(hui:menu-doc KEY-SEQUENCE &optional HELP-STRING-FLAG)

Documentation

Return documentation for a normalized Hyperbole minibuffer menu KEY-SEQUENCE.

The documentation is formatted. With optional HELP-STRING-FLAG, instead returns the one line help string for the key sequence.

Source Code

;; Defined in ~/.emacs.d/elpa/hyperbole-20260414.325/hui-mini.el
(defun hui:menu-doc (key-sequence &optional help-string-flag)
  "Return documentation for a normalized Hyperbole minibuffer menu KEY-SEQUENCE.
The documentation is formatted.  With optional HELP-STRING-FLAG,
instead returns the one line help string for the key sequence."
  (when (and (stringp key-sequence)
	     (not (string-equal key-sequence ""))
	     (kbd-key:hyperbole-mini-menu-key-p key-sequence))
    (let ((hargs:reading-type 'hmenu-help)
	  (hmenu-key-seq (car (where-is-internal #'hyperbole))))
      (unless hmenu-key-seq
	(hypb:error "(hui:menu-doc): The 'hyperbole' command must be bound to a key"))
      (setq unread-command-events
	    (nconc unread-command-events
		   (mapcar #'identity (substring key-sequence (length hmenu-key-seq)))))
      (prog1 (hui:menu-act 'hyperbole nil t help-string-flag)
	;; Ignore any keys past the first menu item activation.
	(discard-input)))))