aboutsummaryrefslogtreecommitdiffstats
path: root/src/keymap.c
diff options
context:
space:
mode:
authorEli Zaretskii2018-09-20 09:41:55 +0300
committerEli Zaretskii2018-09-20 09:41:55 +0300
commitd28d54c76754759e5f0fc8254541fbb4ef6a21d8 (patch)
tree82b1085d14e622b02456145fe0a2230eb9f0ac05 /src/keymap.c
parentb3baf997c8e9bbff351e0bf24b8fdae8831ec1df (diff)
downloademacs-d28d54c76754759e5f0fc8254541fbb4ef6a21d8.tar.gz
emacs-d28d54c76754759e5f0fc8254541fbb4ef6a21d8.zip
More accurate docs for 'text-char-description'
* src/keymap.c (Ftext_char_description): * doc/lispref/help.texi (Describing Characters): More accurate description of 'text-char-description'. Remove incorrect examples from the ELisp manual. (Bug#32743)
Diffstat (limited to 'src/keymap.c')
-rw-r--r--src/keymap.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/keymap.c b/src/keymap.c
index ec483c7a632..fe0781a7f2a 100644
--- a/src/keymap.c
+++ b/src/keymap.c
@@ -2286,7 +2286,8 @@ push_text_char_description (register unsigned int c, register char *p)
2286DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0, 2286DEFUN ("text-char-description", Ftext_char_description, Stext_char_description, 1, 1, 0,
2287 doc: /* Return the description of CHARACTER in standard Emacs notation. 2287 doc: /* Return the description of CHARACTER in standard Emacs notation.
2288CHARACTER must be a valid character code that passes the `characterp' test. 2288CHARACTER must be a valid character code that passes the `characterp' test.
2289Control characters turn into "^char", the 2**7 bit is treated as Meta, etc. 2289Control characters turn into "^char", and characters with Meta and other
2290modifiers signal an error, as they are not valid characterr codes.
2290This differs from `single-key-description' which accepts character events, 2291This differs from `single-key-description' which accepts character events,
2291and thus doesn't enforce the `characterp' condition, turns control 2292and thus doesn't enforce the `characterp' condition, turns control
2292characters into "C-char", and uses the 2**27 bit for Meta. 2293characters into "C-char", and uses the 2**27 bit for Meta.