* keymap.c (Fkey_description): Doc fix.

Fixes: debbugs:9700

diff --git a/src/ChangeLog b/src/ChangeLog
index 8d925c7..0bcbf4e 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -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>

diff --git a/src/keymap.c b/src/keymap.c
index 0ae0552..ecaeb32 100644 (file)
--- a/src/keymap.c
+++ b/src/keymap.c
@@ -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;