From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 23 May 2024 13:23:57 +0000 (+0300)
Subject: Documentation followup for last change
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=11b328e112946a670baf4f3760673da4902088aa;p=emacs.git

Documentation followup for last change

* etc/NEWS: Announce the change in 'key-translate'.

* doc/lispref/commands.texi (Event Mod): Update documentation of
'key-translate'.  (Bug#70139)

(cherry picked from commit b53a20c61d30d4bef43f069b795b8c79bbaf091a)
---

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index b632e5e45ea..925ec765d1e 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -3738,8 +3738,11 @@ if you want to translate characters after input methods operate.
 
 @defun key-translate from to
 This function modifies @code{keyboard-translate-table} to translate
-character code @var{from} into character code @var{to}.  It creates
-the keyboard translate table if necessary.
+character code @var{from} into character code @var{to}.  It creates the
+keyboard translate table if necessary.  Both @var{from} and @var{to}
+should be strings that satisfy @code{key-valid-p} (@pxref{Key
+Sequences}).  If @var{to} is @code{nil}, the function removes any
+existing translation for @var{from}.
 @end defun
 
   Here's an example of using the @code{keyboard-translate-table} to
diff --git a/etc/NEWS b/etc/NEWS
index afb8cb54c60..83e89685ea9 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2365,6 +2365,11 @@ rather than signaling an error.
 It is bound to the key sequence that caused a call to a function bound
 within 'function-key-map' or 'input-decode-map' around those calls.
 
++++
+** The function 'key-translate' can now remove translations.
+If the second argument TO is nil, the existing key translation is
+removed.
+
 +++
 ** New variables describing the names of built in programs.
 The new variables 'ctags-program-name', 'ebrowse-program-name',