diff options
| author | Damien Cassou | 2018-05-28 17:12:34 +0200 |
|---|---|---|
| committer | Noam Postavsky | 2018-05-29 08:17:32 -0400 |
| commit | 24ba63314f29fdffa9cfe012927e5efd744c138d (patch) | |
| tree | fd3abdefa365e0a2357b9ee0328659cc360238e1 | |
| parent | 13963a3a5c83aff1eacee933361e3ac0f21828cd (diff) | |
| download | emacs-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.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 @@ | |||
| 30 | "Ask user a multiple choice question. | 30 | "Ask user a multiple choice question. |
| 31 | PROMPT should be a string that will be displayed as the prompt. | 31 | PROMPT should be a string that will be displayed as the prompt. |
| 32 | 32 | ||
| 33 | CHOICES is an alist where the first element in each entry is a | 33 | CHOICES is a list of (KEY NAME [DESCRIPTION]). KEY is a |
| 34 | character to be entered, the second element is a short name for | 34 | character to be entered. NAME is a short name for the entry to |
| 35 | the entry to be displayed while prompting (if there's room, it | 35 | be displayed while prompting (if there's room, it might be |
| 36 | might be shortened), and the third, optional entry is a longer | 36 | shortened). DESCRIPTION is an optional longer explanation that |
| 37 | explanation that will be displayed in a help buffer if the user | 37 | will be displayed in a help buffer if the user requests more |
| 38 | requests more help. | 38 | help. |
| 39 | 39 | ||
| 40 | This function translates user input into responses by consulting | 40 | This function translates user input into responses by consulting |
| 41 | the bindings in `query-replace-map'; see the documentation of | 41 | the bindings in `query-replace-map'; see the documentation of |
| @@ -46,9 +46,9 @@ perform the requested window recentering or scrolling and ask | |||
| 46 | again. | 46 | again. |
| 47 | 47 | ||
| 48 | When `use-dialog-box' is t (the default), this function can pop | 48 | When `use-dialog-box' is t (the default), this function can pop |
| 49 | up a dialog window to collect the user input. That functionality | 49 | up a dialog window to collect the user input. That functionality |
| 50 | requires `display-popup-menus-p' to return t. Otherwise, a text | 50 | requires `display-popup-menus-p' to return t. Otherwise, a |
| 51 | dialog will be used. | 51 | text dialog will be used. |
| 52 | 52 | ||
| 53 | The return value is the matching entry from the CHOICES list. | 53 | The return value is the matching entry from the CHOICES list. |
| 54 | 54 | ||