From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Damien Cassou Newsgroups: gmane.emacs.bugs Subject: bug#31628: 26.1; Problem in read-multiple-choice's docstring Date: Mon, 28 May 2018 17:23:08 +0200 Message-ID: <87lgc3pzxf.fsf@cassou.me> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: blaine.gmane.org 1527520964 20946 195.159.176.226 (28 May 2018 15:22:44 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 28 May 2018 15:22:44 +0000 (UTC) To: 31628@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon May 28 17:22:40 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fNJyl-0005IQ-VH for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 May 2018 17:22:36 +0200 Original-Received: from localhost ([::1]:56748 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fNK0t-00046I-3L for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 May 2018 11:24:47 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:60069) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fNK0D-0003fR-K3 for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:24:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fNK0A-00034e-VY for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:24:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:44672) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fNK0A-00034Z-Qw for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:24:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fNK0A-0001wh-JE for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:24:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 May 2018 15:24:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 31628 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.15275210187445 (code B ref -1); Mon, 28 May 2018 15:24:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 28 May 2018 15:23:38 +0000 Original-Received: from localhost ([127.0.0.1]:52569 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fNJzk-0001vz-A0 for submit@debbugs.gnu.org; Mon, 28 May 2018 11:23:36 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:40367) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fNJzi-0001vn-En for submit@debbugs.gnu.org; Mon, 28 May 2018 11:23:34 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fNJzc-0002aD-6N for submit@debbugs.gnu.org; Mon, 28 May 2018 11:23:29 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:54910) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fNJzc-0002a6-2X for submit@debbugs.gnu.org; Mon, 28 May 2018 11:23:28 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:59547) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fNJza-0003DG-MQ for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:23:27 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fNJzY-0002XX-2O for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:23:26 -0400 Original-Received: from mail.choca.pics ([2001:bc8:20ab::1]:33220) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fNJzX-0002SR-N2 for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 11:23:23 -0400 Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 1429E233207E for ; Mon, 28 May 2018 17:23:14 +0200 (CEST) Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id 867x-SVz2g-V for ; Mon, 28 May 2018 17:23:13 +0200 (CEST) Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id CFD64233207F for ; Mon, 28 May 2018 17:23:12 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics CFD64233207F DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1527520992; bh=9XYm6+L/10xMRF9WjRpxqEn7mmgvM1/lopSFiD1DBF0=; h=From:To:Date:Message-ID:MIME-Version; b=b0pfKnrH3vY3tJwfnEfilrtcA1msXVbWb2BVnVKpsxQfR1a/LzVQcbI9rYu5nVkQx 5jvpBlJ+ceT+zfqEIqBX173kAI0sn/lkDTGZYpongX3pPhmgaFXmMfvAzPEgGzw3mh meHgkZuAMM1sEUtlCeLhPB+3zWkPG/LMKT+RXM03yhGux9hrtwxE4+Dvc4WYtK2nqK fzFggm57VPLGb9Um53AJq1gv1myQ1ln2/YVmCvP+7pxaKeW4++Hmp/GNQyQsshBZH6 I5vlZxgbA2GCfz0jzIqwULDddzWz/bN0JQhzNtI1e0o1xiqf6l1Fce8kulL3Oit6+M Y65Uz0c6ybFzg== X-Virus-Scanned: amavisd-new at choca.pics Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id zNEVtW-HvxuD for ; Mon, 28 May 2018 17:23:12 +0200 (CEST) Original-Received: from luz4 (20-44-190-109.dsl.ovh.fr [109.190.44.20]) by mail.choca.pics (Postfix) with ESMTPSA id 49065233207E for ; Mon, 28 May 2018 17:23:12 +0200 (CEST) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:146641 Archived-At: --=-=-= Content-Type: text/plain 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 --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-lisp-emacs-lisp-rmc.el-read-multiple-choice-Improve-.patch >From 255c09ac20c940140e20d199b1f715fc98264da5 Mon Sep 17 00:00:00 2001 From: Damien Cassou 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 --=-=-=--