]> git.eshelyaron.com Git - emacs.git/commitdiff
Add kbd examples to the doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Sun, 17 Oct 2021 20:27:13 +0000 (22:27 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sun, 17 Oct 2021 20:27:13 +0000 (22:27 +0200)
* lisp/subr.el (kbd): Add some examples to the doc string.

lisp/subr.el

index 07737e2c08f26876f35bb4bea580931d0e336b80..f2cbe363403c7d17539b52161596400a8e499921 100644 (file)
@@ -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-<left>\"
+    \"M-RET\"
+    \"C-M-<return>\"
+
 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.