summaryrefslogtreecommitdiff
path: root/doc/lispref/help.texi
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-09-10 12:46:22 +0300
committerEli Zaretskii <eliz@gnu.org>2018-09-10 12:46:22 +0300
commit5cf282d65f10f59f7efa63359dfd2b2e124943da (patch)
tree2f46d097912980052ce13faa6433913adc580f72 /doc/lispref/help.texi
parent96281c5ee1582ac0c329d09797ab7ab3dbae26d1 (diff)
downloademacs-5cf282d65f10f59f7efa63359dfd2b2e124943da.tar.gz
Clarify documentation of functions reading character events
* doc/lispref/help.texi (Describing Characters): * doc/lispref/commands.texi (Keyboard Events) (Reading One Event, Classifying Events): Make the distinction between characters and character events more explicit. * src/keymap.c (Ftext_char_description) (Fsingle_key_description): * src/lread.c (Fread_char, Fread_char_exclusive): Doc fixes, to make a clear distinction between a character input event and a character code. (Bug#32562)
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r--doc/lispref/help.texi14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index 6dd55d0b256..a23bc413d25 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -556,13 +556,13 @@ brackets.
@defun text-char-description character
This function returns a string describing @var{character} in the
-standard Emacs notation for characters that appear in text---like
-@code{single-key-description}, except that control characters are
-represented with a leading caret (which is how control characters in
-Emacs buffers are usually displayed). Another difference is that
-@code{text-char-description} recognizes the 2**7 bit as the Meta
-character, whereas @code{single-key-description} uses the 2**27 bit
-for Meta.
+standard Emacs notation for characters that can appear in text---like
+@code{single-key-description}, except that the argument must be a
+valid character code that passes a @code{characterp} test
+(@pxref{Character Codes}), control characters are represented with a
+leading caret (which is how control characters in Emacs buffers are
+usually displayed), and the 2**7 bit is treated as the Meta bit,
+whereas @code{single-key-description} uses the 2**27 bit for Meta.
@smallexample
@group