all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: arash@gnu.org
Cc: 62502@debbugs.gnu.org
Subject: bug#62502: 29.0.60; Docstring of `read-char-choice'
Date: Tue, 28 Mar 2023 21:34:04 +0300	[thread overview]
Message-ID: <83sfdo7mjn.fsf@gnu.org> (raw)
In-Reply-To: <83tty47pjs.fsf@gnu.org> (message from Eli Zaretskii on Tue, 28 Mar 2023 20:29:11 +0300)

> Cc: 62502@debbugs.gnu.org
> Date: Tue, 28 Mar 2023 20:29:11 +0300
> From: Eli Zaretskii <eliz@gnu.org>
> 
> > From: Arash Esbati <arash@gnu.org>
> > 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.





  reply	other threads:[~2023-03-28 18:34 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-28 14:32 bug#62502: 29.0.60; Docstring of `read-char-choice' Arash Esbati
2023-03-28 17:29 ` Eli Zaretskii
2023-03-28 18:34   ` Eli Zaretskii [this message]
2023-03-29  7:26     ` Arash Esbati

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83sfdo7mjn.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=62502@debbugs.gnu.org \
    --cc=arash@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.