From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#62502: 29.0.60; Docstring of `read-char-choice' Date: Tue, 28 Mar 2023 21:34:04 +0300 Message-ID: <83sfdo7mjn.fsf@gnu.org> References: <86tty52bgq.fsf@gnu.org> <83tty47pjs.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18113"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 62502@debbugs.gnu.org To: arash@gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Mar 28 20:35:24 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 1phEAG-0004Tl-Ej for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 28 Mar 2023 20:35:24 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1phE9w-0005Z6-01; Tue, 28 Mar 2023 14:35:04 -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 1phE9v-0005Yx-0R for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 14:35: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 1phE9u-0006DA-NA for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 14:35:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1phE9u-0003NH-9n for bug-gnu-emacs@gnu.org; Tue, 28 Mar 2023 14:35:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 28 Mar 2023 18:35:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 62502 X-GNU-PR-Package: emacs Original-Received: via spool by 62502-submit@debbugs.gnu.org id=B62502.168002845012885 (code B ref 62502); Tue, 28 Mar 2023 18:35:02 +0000 Original-Received: (at 62502) by debbugs.gnu.org; 28 Mar 2023 18:34:10 +0000 Original-Received: from localhost ([127.0.0.1]:50692 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phE93-0003Ll-TR for submit@debbugs.gnu.org; Tue, 28 Mar 2023 14:34:10 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:58168) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1phE90-0003LB-Nw for 62502@debbugs.gnu.org; Tue, 28 Mar 2023 14:34:07 -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 1phE8t-0005tP-VC for 62502@debbugs.gnu.org; Tue, 28 Mar 2023 14:34:00 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-version:References:Subject:In-Reply-To:To:From: Date; bh=UvofefAqvWhQ8XhzOxP5MJa4P/QrHmE0FiP6JMRnMvc=; b=jGPrzTqveqSBuPIy4zOf umFxwo4FvSkS8ypJpiZpZyNVovqF5osurLgmoIf27OC5AnkZb9erXFePGmlLR+1q3Chk5QTvPyZU7 GamkSqO0ZUDSNBKr/30aETHm+BF5ltYfVfHVjy9bMhTi43RRsfZBHJ7O4szzha64Yd/zkI00u54LX 6NSNcWalYTHamFYyEBCfNcJzz4V1E9z1Ny9e34sTa0Jia4azyRJC0oQvNVakHe04oWGsyoG1UE9jd saIJJkmbddda1NNjDQ6WhD3Oj5eWs5reDOAiU/j+4qP8zK88sb8fQyTjbE+nLfmHqxle40YjaLDSP RS1oqMQDIKFDkA==; Original-Received: from [87.69.77.57] (helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1phE8t-0000mm-1c; Tue, 28 Mar 2023 14:33:59 -0400 In-Reply-To: <83tty47pjs.fsf@gnu.org> (message from Eli Zaretskii on Tue, 28 Mar 2023 20:29:11 +0300) 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:258820 Archived-At: > Cc: 62502@debbugs.gnu.org > Date: Tue, 28 Mar 2023 20:29:11 +0300 > From: Eli Zaretskii > > > From: Arash Esbati > > Date: Tue, 28 Mar 2023 16:32:21 +0200 > > > > docstring of `read-char-choice' lacks any information about > > INHIBIT-KEYBOARD-QUIT: > > That's because by default that argument is ignored. > > > INHIBIT-KEYBOARD-QUIT is passed to `read-char-choice-with-read-key'; I'd > > say it is sufficient to say something like: > > > > If ‘read-char-choice-use-read-key’ is non-nil, the modal ‘read-key’ > > function is used instead (see ‘read-char-choice-with-read-key’) and > > the optional INHIBIT-KEYBOARD-QUIT is passed to it. > > Is it really useful? I believe read-char-choice-with-read-key is kept > for possible backward compatibility; new Lisp programs that want to > use read-char-choice-with-read-key should just call it directly, and > in its doc string this argument is documented. > > So I'm not sure we should do anything about this issue. Since the state of documentation of this and related functions/variables was unsatisfactory, I ended up fixing it, and as part of that also mentioned what happens with INHIBIT-KEYBOARD-QUIT. Thanks.