GNU bug report logs - #77889
[PATCH] Clarify insert-char when called from Lisp

Previous Next

To reply to this bug, email your comments to 77889 AT debbugs.gnu.org.
There is no need to reopen the bug first.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Lactose ‎ <lactose <at> allthingslinux.org>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] Clarify insert-char when called from Lisp
Date: Thu, 17 Apr 2025 18:39:30 -0700

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

The doc for `insert-char' is unclear what values are valid for CHARACTER
when called from Lisp. This clarifies that only code points can be
passed when called from Lisp instead of interactively.

> Interactively, prompt for CHARACTER using `read-char-by-name'.
> You can specify CHARACTER in one of these ways:

This reads to me as two separate, unrelated statements. Somemone could
interpret the latter as applying when called from Lisp, when in fact it's
only true when called interactively.

> Interactively, prompt for CHARACTER using `read-char-by-name'.
> When prompted, you can specify CHARACTER in one of these ways:

This is much better as it is now clear it only applies when
called interactively.

In addition, I added details on how to call `insert-char' from Lisp.

> When called from Lisp, you can only pass CHARACTER as a code point.
> See `char-from-name' for retrieving a code point from a Unicode character name.

[insert-char-doc.patch (text/x-patch, attachment)]

Message #10 received at 77889-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lactose ‎ <lactose <at> allthingslinux.org>
Cc: 77889-done <at> debbugs.gnu.org
Subject: Re: bug#77889: [PATCH] Clarify insert-char when called from Lisp
Date: Fri, 18 Apr 2025 14:11:58 +0300

> From: Lactose ‎ <lactose <at> allthingslinux.org>
> Date: Thu, 17 Apr 2025 18:39:30 -0700
> 
> The doc for `insert-char' is unclear what values are valid for CHARACTER
> when called from Lisp. This clarifies that only code points can be
> passed when called from Lisp instead of interactively.
> 
> > Interactively, prompt for CHARACTER using `read-char-by-name'.
> > You can specify CHARACTER in one of these ways:
> 
> This reads to me as two separate, unrelated statements. Somemone could
> interpret the latter as applying when called from Lisp, when in fact it's
> only true when called interactively.
> 
> > Interactively, prompt for CHARACTER using `read-char-by-name'.
> > When prompted, you can specify CHARACTER in one of these ways:
> 
> This is much better as it is now clear it only applies when
> called interactively.
> 
> In addition, I added details on how to call `insert-char' from Lisp.
> 
> > When called from Lisp, you can only pass CHARACTER as a code point.
> > See `char-from-name' for retrieving a code point from a Unicode character name.

Thanks, I used these ideas and suggestions to fix the doc string in a
slightly different way.  Done on the emacs-30 branch, and closing the
bug.

Previous Next

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