Function: shortdoc-display-group

shortdoc-display-group is an autoloaded, interactive and byte-compiled function defined in shortdoc.el.gz.

Signature

(shortdoc-display-group GROUP &optional FUNCTION SAME-WINDOW)

Documentation

Pop to a buffer with short documentation summary for functions in GROUP.

Interactively, prompt for GROUP. If FUNCTION is non-nil, place point on the entry for FUNCTION (if any). If SAME-WINDOW, don't pop to a new window.

Probably introduced at or before Emacs version 28.1.

Key Bindings

Aliases

shortdoc

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/shortdoc.el.gz
;;;###autoload
(defun shortdoc-display-group (group &optional function same-window)
  "Pop to a buffer with short documentation summary for functions in GROUP.
Interactively, prompt for GROUP.
If FUNCTION is non-nil, place point on the entry for FUNCTION (if any).
If SAME-WINDOW, don't pop to a new window."
  (interactive (list (completing-read
                      "Group of functions for which to show summary: "
                      (mapcar #'car shortdoc--groups))))
  (when (stringp group)
    (setq group (intern group)))
  (unless (assq group shortdoc--groups)
    (error "No such documentation group %s" group))
  (let ((buf (get-buffer-create (format "*Shortdoc %s*" group))))
    (shortdoc--insert-group-in-buffer group buf)
    (funcall (if same-window
                 #'pop-to-buffer-same-window
               #'pop-to-buffer)
             buf))
  (goto-char (point-min))
  (when function
    (text-property-search-forward 'shortdoc-function function t)
    (beginning-of-line)))