From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Arash Esbati Newsgroups: gmane.emacs.bugs Subject: bug#62502: 29.0.60; Docstring of `read-char-choice' Date: Tue, 28 Mar 2023 16:32:21 +0200 Message-ID: <86tty52bgq.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="15590"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: 62502@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Mar 28 16:33:18 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1phANy-0003rR-Ga for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Mar 2023 16:33:18 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1phANn-0006UB-H2; Tue, 28 Mar 2023 10:33:07 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1phANi-0006SS-WE for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:33:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1phANi-0007oT-8o for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:33:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1phANi-0002iD-1S for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:33:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Arash Esbati Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 28 Mar 2023 14:33:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 62502 X-GNU-PR-Package: emacs X-Debbugs-Original-To: emacs-bugs Original-Received: via spool by submit@debbugs.gnu.org id=B.168001396010395 (code B ref -1); Tue, 28 Mar 2023 14:33:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 28 Mar 2023 14:32:40 +0000 Original-Received: from localhost ([127.0.0.1]:50474 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phANL-0002hb-LE for submit@debbugs.gnu.org; Tue, 28 Mar 2023 10:32:39 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:57592) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phANK-0002hT-87 for submit@debbugs.gnu.org; Tue, 28 Mar 2023 10:32:38 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1phANJ-0006IQ-D2 for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:32:37 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1phANJ-0007i8-5U for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:32:37 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:Subject:To:From:in-reply-to: references; bh=MBN0vCel8QUOxOvZ1LWQPStWi7jK1hFiZJMCXoqKs2Y=; b=SUq60v6EaeBTW0 5DYErRcacjgG8/lF4CPGHjv5szr5SkhpvukGJSyTw2oamGYdNbk1uAbvOiYoNRbMBd22fLkUIMgSf bf+n6oKXip6ITDtJz9RdZn4jwTYT2G4CDq+t2xiHd8bdSdobCQUY/X7LPfHe6KnSx40Q90uiBERxg rRWOp2v8dTKkCXa0dJH9nWvW+C52yXUMDQBJUYRxmjMfY2OZOP6nzivWJ0X8I+/rs9gGIIEINAnEs fveQZgaa8m6qK6rOi/5uFimnzC6EAy9r9bn+VuUNzrnJ1wN+ZSbm7tdcVTgYTK0Pxs8v8CT06taz5 OpsQ4O+dMW5SgwC/HqkQ==; Original-Received: from p5b326472.dip0.t-ipconnect.de ([91.50.100.114] helo=MUTANT) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1phANI-0002GN-Am for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 10:32:36 -0400 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:258809 Archived-At: Hi all, docstring of `read-char-choice' lacks any information about INHIBIT-KEYBOARD-QUIT: ,----[ C-h f read-char-choice RET ] | read-char-choice is a native-compiled Lisp function in =E2=80=98subr.el= =E2=80=99. |=20 | (read-char-choice PROMPT CHARS &optional INHIBIT-KEYBOARD-QUIT) |=20 | Read and return one of CHARS, prompting for PROMPT. | Any input that is not one of CHARS is ignored. |=20 | By default, the minibuffer is used to read the key | non-modally (see =E2=80=98read-char-from-minibuffer=E2=80=99). If | =E2=80=98read-char-choice-use-read-key=E2=80=99 is non-nil, the modal =E2= =80=98read-key=E2=80=99 | function is used instead (see =E2=80=98read-char-choice-with-read-key=E2= =80=99). |=20 | Probably introduced at or before Emacs version 24.1. |=20 `---- INHIBIT-KEYBOARD-QUIT is passed to `read-char-choice-with-read-key'; I'd say it is sufficient to say something like: If =E2=80=98read-char-choice-use-read-key=E2=80=99 is non-nil, the modal = =E2=80=98read-key=E2=80=99 function is used instead (see =E2=80=98read-char-choice-with-read-key=E2= =80=99) and the optional INHIBIT-KEYBOARD-QUIT is passed to it. Best, Arash