summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-04-29 20:27:22 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-05-01 19:27:09 +0200
commitbc6c294d606266a410abdb8954bf6d4acbd21df9 (patch)
treea23004f459ff28a5daee6e6d1a76cb782fdcd0b6
parent28ef870c7a0936648cb0bc1ae721f2caa575391e (diff)
downloademacs-bc6c294d606266a410abdb8954bf6d4acbd21df9.tar.gz
Doc fix for `kbd'
* lisp/subr.el (kbd): Describe more fully the format of the parameter (bug#17039). (cherry picked from commit 3a33afe25d8518f194fa4706eaccdb2a786a0348)
-rw-r--r--lisp/subr.el6
1 files changed, 4 insertions, 2 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 0fb4a2ec256..ce49604f811 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))