]> code.delx.au - gnu-emacs/commitdiff
* keymap.c (Fkey_description): Doc fix.
authorChong Yidong <cyd@gnu.org>
Sun, 11 Mar 2012 17:08:10 +0000 (01:08 +0800)
committerChong Yidong <cyd@gnu.org>
Sun, 11 Mar 2012 17:08:10 +0000 (01:08 +0800)
Fixes: debbugs:9700
src/ChangeLog
src/keymap.c

index 8d925c7bbadd0c03a5f781908c61ab559506aeb9..0bcbf4e269a9e959651169f1b2ed8890c6517bdf 100644 (file)
@@ -1,5 +1,7 @@
 2012-03-11  Chong Yidong  <cyd@gnu.org>
 
+       * keymap.c (Fkey_description): Doc fix (Bug#9700).
+
        * editfns.c (Fconstrain_to_field): Doc fix (Bug#9452).
 
 2012-03-10  Chong Yidong  <cyd@gnu.org>
index 0ae055213c3e0c66218f5751dda3de166d8bc88a..ecaeb32896e83502f524f103a0376270f89e01c4 100644 (file)
@@ -2043,8 +2043,9 @@ static Lisp_Object Qsingle_key_description, Qkey_description;
 DEFUN ("key-description", Fkey_description, Skey_description, 1, 2, 0,
        doc: /* Return a pretty description of key-sequence KEYS.
 Optional arg PREFIX is the sequence of keys leading up to KEYS.
-Control characters turn into "C-foo" sequences, meta into "M-foo",
-spaces are put between sequence elements, etc.  */)
+For example, [?\C-x ?l] is converted into the string \"C-x l\".
+
+The `kbd' macro is an approximate inverse of this.  */)
   (Lisp_Object keys, Lisp_Object prefix)
 {
   int len = 0;