Doc fix for `kbd'

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

(cherry picked from commit 3a33afe25d)
This commit is contained in:
Lars Ingebrigtsen 2016-04-29 20:27:22 +02:00
parent 28ef870c7a
commit bc6c294d60

View 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))