aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDamien Cassou2018-05-28 17:12:34 +0200
committerNoam Postavsky2018-05-29 08:17:32 -0400
commit24ba63314f29fdffa9cfe012927e5efd744c138d (patch)
treefd3abdefa365e0a2357b9ee0328659cc360238e1
parent13963a3a5c83aff1eacee933361e3ac0f21828cd (diff)
downloademacs-24ba63314f29fdffa9cfe012927e5efd744c138d.tar.gz
emacs-24ba63314f29fdffa9cfe012927e5efd744c138d.zip
Improve read-multiple-choice docstring (Bug#31628)
* lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve docstring.
-rw-r--r--lisp/emacs-lisp/rmc.el18
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 @@
30 "Ask user a multiple choice question. 30 "Ask user a multiple choice question.
31PROMPT should be a string that will be displayed as the prompt. 31PROMPT should be a string that will be displayed as the prompt.
32 32
33CHOICES is an alist where the first element in each entry is a 33CHOICES is a list of (KEY NAME [DESCRIPTION]). KEY is a
34character to be entered, the second element is a short name for 34character to be entered. NAME is a short name for the entry to
35the entry to be displayed while prompting (if there's room, it 35be displayed while prompting (if there's room, it might be
36might be shortened), and the third, optional entry is a longer 36shortened). DESCRIPTION is an optional longer explanation that
37explanation that will be displayed in a help buffer if the user 37will be displayed in a help buffer if the user requests more
38requests more help. 38help.
39 39
40This function translates user input into responses by consulting 40This function translates user input into responses by consulting
41the bindings in `query-replace-map'; see the documentation of 41the bindings in `query-replace-map'; see the documentation of
@@ -46,9 +46,9 @@ perform the requested window recentering or scrolling and ask
46again. 46again.
47 47
48When `use-dialog-box' is t (the default), this function can pop 48When `use-dialog-box' is t (the default), this function can pop
49up a dialog window to collect the user input. That functionality 49up a dialog window to collect the user input. That functionality
50requires `display-popup-menus-p' to return t. Otherwise, a text 50requires `display-popup-menus-p' to return t. Otherwise, a
51dialog will be used. 51text dialog will be used.
52 52
53The return value is the matching entry from the CHOICES list. 53The return value is the matching entry from the CHOICES list.
54 54