diff options
author | Damien Cassou <damien@cassou.me> | 2018-05-28 17:12:34 +0200 |
---|---|---|
committer | Noam Postavsky <npostavs@gmail.com> | 2018-05-29 08:17:32 -0400 |
commit | 24ba63314f29fdffa9cfe012927e5efd744c138d (patch) | |
tree | fd3abdefa365e0a2357b9ee0328659cc360238e1 /lisp/emacs-lisp | |
parent | 13963a3a5c83aff1eacee933361e3ac0f21828cd (diff) | |
download | emacs-24ba63314f29fdffa9cfe012927e5efd744c138d.tar.gz emacs-24ba63314f29fdffa9cfe012927e5efd744c138d.tar.bz2 emacs-24ba63314f29fdffa9cfe012927e5efd744c138d.zip |
Improve read-multiple-choice docstring (Bug#31628)
* lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve docstring.
Diffstat (limited to 'lisp/emacs-lisp')
-rw-r--r-- | lisp/emacs-lisp/rmc.el | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/lisp/emacs-lisp/rmc.el b/lisp/emacs-lisp/rmc.el index 3dd3508903a..31974782b53 100644 --- a/lisp/emacs-lisp/rmc.el +++ b/lisp/emacs-lisp/rmc.el @@ -30,12 +30,12 @@ "Ask user a multiple choice question. PROMPT should be a string that will be displayed as the prompt. -CHOICES is an alist where the first element in each entry is a -character to be entered, the second element is a short name for -the entry to be displayed while prompting (if there's room, it -might be shortened), and the third, optional entry is a longer -explanation that will be displayed in a help buffer if the user -requests more help. +CHOICES is a list of (KEY NAME [DESCRIPTION]). KEY is a +character to be entered. NAME is a short name for the entry to +be displayed while prompting (if there's room, it might be +shortened). DESCRIPTION is an optional longer explanation that +will be displayed in a help buffer if the user requests more +help. This function translates user input into responses by consulting the bindings in `query-replace-map'; see the documentation of @@ -46,9 +46,9 @@ perform the requested window recentering or scrolling and ask again. When `use-dialog-box' is t (the default), this function can pop -up a dialog window to collect the user input. That functionality -requires `display-popup-menus-p' to return t. Otherwise, a text -dialog will be used. +up a dialog window to collect the user input. That functionality +requires `display-popup-menus-p' to return t. Otherwise, a +text dialog will be used. The return value is the matching entry from the CHOICES list. |