emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

master 1638f81: Add kbd examples to the doc string


From: Lars Ingebrigtsen
Subject: master 1638f81: Add kbd examples to the doc string
Date: Sun, 17 Oct 2021 16:27:21 -0400 (EDT)

branch: master
commit 1638f81f9d53d1248db2e48d8ca85f2aeab7690b
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    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 07737e2..f2cbe36 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-<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.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]