From: Chong Yidong <cyd@gnu.org>
Date: Sun, 11 Mar 2012 17:08:10 +0000 (+0800)
Subject: * keymap.c (Fkey_description): Doc fix.
X-Git-Tag: emacs-pretest-24.0.05~99
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=413df973020798154647c0de054cb6a423d2f656;p=emacs.git

* keymap.c (Fkey_description): Doc fix.

Fixes: debbugs:9700
---

diff --git a/src/ChangeLog b/src/ChangeLog
index 8d925c7bbad..0bcbf4e269a 100644
--- 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 0ae055213c3..ecaeb32896e 100644
--- 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;