From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 29 Apr 2016 18:27:22 +0000 (+0200)
Subject: Doc fix for `kbd'
X-Git-Tag: emacs-25.0.94~107
X-Git-Url: https://code.delx.au/gnu-emacs/commitdiff_plain/bc6c294d606266a410abdb8954bf6d4acbd21df9

Doc fix for `kbd'

* lisp/subr.el (kbd): Describe more fully the format of the
parameter (bug#17039).

(cherry picked from commit 3a33afe25d8518f194fa4706eaccdb2a786a0348)
---

diff --git a/lisp/subr.el b/lisp/subr.el
index 0fb4a2ec25..ce49604f81 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -619,8 +619,10 @@ side-effects, and the argument LIST is not modified."
 
 (defun kbd (keys)
   "Convert KEYS to the internal Emacs key representation.
-KEYS should be a string constant in the format used for
-saving keyboard macros (see `edmacro-mode')."
+KEYS should be a string in the format returned by commands such
+as `C-h k' (`describe-key').
+This is the same format used for saving keyboard macros (see
+`edmacro-mode')."
   ;; Don't use a defalias, since the `pure' property is only true for
   ;; the calling convention of `kbd'.
   (read-kbd-macro keys))