]> code.delx.au - gnu-emacs/commitdiff
Doc fix for `kbd'
authorLars Ingebrigtsen <larsi@gnus.org>
Fri, 29 Apr 2016 18:27:22 +0000 (20:27 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 1 May 2016 17:27:09 +0000 (19:27 +0200)
* lisp/subr.el (kbd): Describe more fully the format of the
parameter (bug#17039).

(cherry picked from commit 3a33afe25d8518f194fa4706eaccdb2a786a0348)

lisp/subr.el

index 0fb4a2ec2564c92ad433402e8aac91339391c628..ce49604f81148a64c00ec5ac284eee2935c2e7c8 100644 (file)
@@ -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))