From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Juri Linkov Newsgroups: gmane.emacs.bugs Subject: bug#50390: Improve documentation of 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key' Date: Sun, 05 Sep 2021 11:08:13 +0300 Organization: LINKOV.NET Message-ID: <87mtorv40i.fsf@mail.linkov.net> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="38277"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (x86_64-pc-linux-gnu) Cc: 50390@debbugs.gnu.org To: Stefan Kangas Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 05 10:12:39 2021 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 1mMnGZ-0009m0-29 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Sep 2021 10:12:39 +0200 Original-Received: from localhost ([::1]:40256 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mMnGX-0006Aa-Pq for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Sep 2021 04:12:37 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60308) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mMnFy-0005xW-Qf for bug-gnu-emacs@gnu.org; Sun, 05 Sep 2021 04:12:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:37582) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mMnFy-0003P3-Ix for bug-gnu-emacs@gnu.org; Sun, 05 Sep 2021 04:12:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1mMnFy-0007NG-Er for bug-gnu-emacs@gnu.org; Sun, 05 Sep 2021 04:12:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Juri Linkov Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 05 Sep 2021 08:12:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 50390 X-GNU-PR-Package: emacs Original-Received: via spool by 50390-submit@debbugs.gnu.org id=B50390.163082946628271 (code B ref 50390); Sun, 05 Sep 2021 08:12:02 +0000 Original-Received: (at 50390) by debbugs.gnu.org; 5 Sep 2021 08:11:06 +0000 Original-Received: from localhost ([127.0.0.1]:49127 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mMnF4-0007Lv-Gs for submit@debbugs.gnu.org; Sun, 05 Sep 2021 04:11:06 -0400 Original-Received: from relay3-d.mail.gandi.net ([217.70.183.195]:43009) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1mMnF2-0007Kv-It for 50390@debbugs.gnu.org; Sun, 05 Sep 2021 04:11:05 -0400 Original-Received: (Authenticated sender: juri@linkov.net) by relay3-d.mail.gandi.net (Postfix) with ESMTPSA id 95FEE60003; Sun, 5 Sep 2021 08:10:57 +0000 (UTC) In-Reply-To: (Stefan Kangas's message of "Sun, 5 Sep 2021 04:56:18 +0200") 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" Xref: news.gmane.io gmane.emacs.bugs:213469 Archived-At: > I read in NEWS for Emacs 28: > > New variables 'read-char-choice-use-read-key' and 'y-or-n-p-use-read-key'. > > When I look into the documentation of those variables, I do not get > any explanation of why I would want to use them. I also can't find > any explanation in the manual. > > Even just one or two sentences that indicates its typical use would be > very helpful here. The problem is that read-char-choice still has no docstring. After adding it, the docstring of read-char-choice should refer to read-char-choice-use-read-key and explain it. y-or-n-p already has docstring and should mention y-or-n-p-use-read-key.