all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Damien Cassou <damien@cassou.me>
To: 31628@debbugs.gnu.org
Subject: bug#31628: 26.1; Problem in read-multiple-choice's docstring
Date: Mon, 28 May 2018 17:23:08 +0200	[thread overview]
Message-ID: <87lgc3pzxf.fsf@cassou.me> (raw)

[-- Attachment #1: Type: text/plain, Size: 361 bytes --]

Attached patch fixes the docstring of read-multiple-choice. Previous
docstring, said CHOICES was an alist which it isn't. The new docstring
fixes that and gives names to components of each choice.

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-lisp-emacs-lisp-rmc.el-read-multiple-choice-Improve-.patch --]
[-- Type: text/x-patch, Size: 1430 bytes --]

From 255c09ac20c940140e20d199b1f715fc98264da5 Mon Sep 17 00:00:00 2001
From: Damien Cassou <damien@cassou.me>
Date: Mon, 28 May 2018 17:12:34 +0200
Subject: [PATCH] * lisp/emacs-lisp/rmc.el (read-multiple-choice): Improve
 docstring.

---
 lisp/emacs-lisp/rmc.el | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/lisp/emacs-lisp/rmc.el b/lisp/emacs-lisp/rmc.el
index 3dd3508903..9813dcf2e5 100644
--- a/lisp/emacs-lisp/rmc.el
+++ b/lisp/emacs-lisp/rmc.el
@@ -30,12 +30,11 @@ read-multiple-choice
   "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 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
-- 
2.17.0


             reply	other threads:[~2018-05-28 15:23 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-28 15:23 Damien Cassou [this message]
2018-05-28 18:07 ` bug#31628: 26.1; Problem in read-multiple-choice's docstring Basil L. Contovounesios
2018-05-29  6:04   ` Damien Cassou
2018-05-29 12:18     ` Noam Postavsky
2018-05-29 13:49   ` Drew Adams
2018-05-29 16:39     ` Basil L. Contovounesios

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87lgc3pzxf.fsf@cassou.me \
    --to=damien@cassou.me \
    --cc=31628@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.