; Improve documentation of 'shortdoc'
* lisp/emacs-lisp/shortdoc.el (shortdoc-display-group): Fix doc string and wording of prompt. (Bug#76723)
This commit is contained in:
parent
d6288eeb42
commit
0383937a70
1 changed files with 4 additions and 2 deletions
|
@ -1468,10 +1468,12 @@ A FUNC form can have any number of `:no-eval' (or `:no-value'),
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defun shortdoc-display-group (group &optional function same-window)
|
(defun shortdoc-display-group (group &optional function same-window)
|
||||||
"Pop to a buffer with short documentation summary for functions in GROUP.
|
"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 FUNCTION is non-nil, place point on the entry for FUNCTION (if any).
|
||||||
If SAME-WINDOW, don't pop to a new window."
|
If SAME-WINDOW, don't pop to a new window."
|
||||||
(interactive (list (completing-read "Show summary for functions in: "
|
(interactive (list (completing-read
|
||||||
(mapcar #'car shortdoc--groups))))
|
"Group of functions for which to show summary: "
|
||||||
|
(mapcar #'car shortdoc--groups))))
|
||||||
(when (stringp group)
|
(when (stringp group)
|
||||||
(setq group (intern group)))
|
(setq group (intern group)))
|
||||||
(unless (assq group shortdoc--groups)
|
(unless (assq group shortdoc--groups)
|
||||||
|
|
Loading…
Add table
Reference in a new issue