From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: "Basil L. Contovounesios" Newsgroups: gmane.emacs.bugs Subject: bug#31628: 26.1; Problem in read-multiple-choice's docstring Date: Mon, 28 May 2018 19:07:25 +0100 Message-ID: <877enn64de.fsf@tcd.ie> References: <87lgc3pzxf.fsf@cassou.me> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1527530773 1330 195.159.176.226 (28 May 2018 18:06:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 28 May 2018 18:06:13 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 31628@debbugs.gnu.org To: Damien Cassou Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon May 28 20:06:09 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 1fNMX2-0000ED-Ia for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 May 2018 20:06:08 +0200 Original-Received: from localhost ([::1]:57344 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fNMZ9-0004gj-FO for geb-bug-gnu-emacs@m.gmane.org; Mon, 28 May 2018 14:08:19 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:39006) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fNMYy-0004fl-Bj for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 14:08:09 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fNMYt-0005M1-Cd for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 14:08:08 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:44797) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fNMYt-0005Lw-80 for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 14:08:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1fNMYs-0005qd-6t for bug-gnu-emacs@gnu.org; Mon, 28 May 2018 14:08:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Basil L. Contovounesios" Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 28 May 2018 18:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 31628 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 31628-submit@debbugs.gnu.org id=B31628.152753085422447 (code B ref 31628); Mon, 28 May 2018 18:08:02 +0000 Original-Received: (at 31628) by debbugs.gnu.org; 28 May 2018 18:07:34 +0000 Original-Received: from localhost ([127.0.0.1]:52694 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fNMYQ-0005pz-Ln for submit@debbugs.gnu.org; Mon, 28 May 2018 14:07:34 -0400 Original-Received: from mail-wm0-f54.google.com ([74.125.82.54]:36224) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1fNMYP-0005pl-5k for 31628@debbugs.gnu.org; Mon, 28 May 2018 14:07:33 -0400 Original-Received: by mail-wm0-f54.google.com with SMTP id v131-v6so14879048wma.1 for <31628@debbugs.gnu.org>; Mon, 28 May 2018 11:07:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=tcd-ie.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=fKKjw8Cv39hWWB5jSAG53vItq8BSY9Y7Kk+yWQzO5wM=; b=fm+XkgvE6lA3/ZoWq1hCAfxa1zU0CUQE1d+/AghjK5fLzVy9YTc4wlaVnruwNXwrYP TZc9QpRsaUAz1qMJHBunDb324p5VOgPdFIOoTn1Ab7AzPLYvqM5MZUaKvfbsTADwe5hL 7Q7JmsgRsHeWF0c+NRYYStwYmI6MoenmCYAROzSRWWSX1aS2QSG/WlHn3BAd9LFuAqLy XadidIZFtPb4ot/xnBaF13zwUIEheAOQWAPI+7s8HMzz/LR9eg+zaxQ3n/l82OgN5NBJ 2N47F144g0pLP2GXxfP+1J18XNbT9ECfSRLcdWZ0Gm9xtw5KHxXLVNmsvNgbIJ0bifdE NF0w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=fKKjw8Cv39hWWB5jSAG53vItq8BSY9Y7Kk+yWQzO5wM=; b=AOCfVu2xWerCZzSlGOLwM7BjQFuNrZUBDx+WvmTk9UrtmrgDaHFRfgozeZ27aNyE6+ V5xTKFJvd35g8FxRDUXlkcY+Y5ni5gGqZ7OoL+GjKU69bpV0siTH4WFbDKCaArAwceW6 nVu0VwzeH2uR9LR3KNNTgXAe3npE9EFWmKe0/wz7dKAGag2GjB00maEDZ4wR6N/gJBlU +T1SxYWdI5LWedmrlnE6qIaut6QfpsOEEOannMnf9oyqE0/+w/+5B5F7iwhxVdTvGXLu /yNvu03qH0sAEslvqM7mBidg/lkVX3CpeelzaNLRxmlsjPubf35TlaJIPFPYrnPuU/Cj aSLQ== X-Gm-Message-State: ALKqPwdKb1+4tmk7aihhvSWGv2GcTTmYMi6dyIw2kqj0Ky4TmamOAZbm Nz3A+nIOFapwg9fzj4NwFkWlfSWi X-Google-Smtp-Source: AB8JxZon8eedBLQ5I2MYWRn5i25Z/iRbRo83fAb0KBwXo1sGMjvh9QjweP/Q+sE1M3N31jx9Izh2cg== X-Received: by 2002:a50:9ae1:: with SMTP id p88-v6mr15778466edb.20.1527530847439; Mon, 28 May 2018 11:07:27 -0700 (PDT) Original-Received: from localhost ([213.233.149.25]) by smtp.gmail.com with ESMTPSA id x3-v6sm7037426eda.55.2018.05.28.11.07.26 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 28 May 2018 11:07:26 -0700 (PDT) In-Reply-To: <87lgc3pzxf.fsf@cassou.me> (Damien Cassou's message of "Mon, 28 May 2018 17:23:08 +0200") 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:146659 Archived-At: Damien Cassou writes: > Previous docstring, said CHOICES was an alist which it isn't. Technically, a list of (A B C) is as much an alist as a list of (A . B), but I agree that the docstring can be clarified a bit. > 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. I think the full stops should be followed by two spaces, as per the default sentence-end-double-space. -- Basil