From 1638f81f9d53d1248db2e48d8ca85f2aeab7690b Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 17 Oct 2021 22:27:13 +0200 Subject: [PATCH] Add kbd examples to the doc string * lisp/subr.el (kbd): Add some examples to the doc string. --- lisp/subr.el | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lisp/subr.el b/lisp/subr.el index 07737e2c08f..f2cbe363403 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -971,9 +971,18 @@ which is "Convert KEYS to the internal Emacs key representation. 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'). +Here's some example key sequences: + + \"f\" + \"C-c C-c\" + \"H-\" + \"M-RET\" + \"C-M-\" + For an approximate inverse of this, see `key-description'." (declare (pure t) (side-effect-free t)) ;; A pure function is expected to preserve the match data. -- 2.39.2