GNU bug report logs - #62502
29.0.60; Docstring of `read-char-choice'

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Arash Esbati <arash <at> gnu.org>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#62502: closed (29.0.60; Docstring of `read-char-choice')
Date: Wed, 29 Mar 2023 07:27:02 +0000

[Message part 1 (text/plain, inline)]

Your message dated Wed, 29 Mar 2023 09:26:36 +0200
with message-id <86355of26r.fsf <at> gnu.org>
and subject line Re: bug#62502: 29.0.60; Docstring of `read-char-choice'
has caused the debbugs.gnu.org bug report #62502,
regarding 29.0.60; Docstring of `read-char-choice'
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
62502: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=62502
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: Arash Esbati <arash <at> gnu.org>
To: emacs-bugs <bug-gnu-emacs <at> gnu.org>
Subject: 29.0.60; Docstring of `read-char-choice'
Date: Tue, 28 Mar 2023 16:32:21 +0200

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 ‘subr.el’.
| 
| (read-char-choice PROMPT CHARS &optional INHIBIT-KEYBOARD-QUIT)
| 
| Read and return one of CHARS, prompting for PROMPT.
| Any input that is not one of CHARS is ignored.
| 
| By default, the minibuffer is used to read the key
| non-modally (see ‘read-char-from-minibuffer’).  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’).
| 
|   Probably introduced at or before Emacs version 24.1.
| 
`----

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.

Best, Arash

[Message part 3 (message/rfc822, inline)]

From: Arash Esbati <arash <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 62502-done <at> debbugs.gnu.org
Subject: Re: bug#62502: 29.0.60; Docstring of `read-char-choice'
Date: Wed, 29 Mar 2023 09:26:36 +0200

Eli Zaretskii <eliz <at> gnu.org> writes:

> 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.

Yes, the documentation is in much better shape now.  Thanks for fixing
this.  I'm closing this report.

Best, Arash

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.