summaryrefslogtreecommitdiff
path: root/lisp/keymap.el
diff options
context:
space:
mode:
authorRobert Pluim <rpluim@gmail.com>2023-03-20 09:44:33 +0100
committerRobert Pluim <rpluim@gmail.com>2023-03-20 09:47:32 +0100
commiteed240bc022cef4ef0f2b12bd2ff116eb6b9581d (patch)
tree783edac1593ac20ef8220e9b3ec24ccb4c3b1b70 /lisp/keymap.el
parentb7f03333551b2214f4d151d25d319e62402167c1 (diff)
Improve defvar-keymap docstring.
* lisp/keymap.el (defvar-keymap): Improve description of ':enter' and ':exit' usage for ':repeat' keyword.
Diffstat (limited to 'lisp/keymap.el')
-rw-r--r--lisp/keymap.el19
1 files changed, 11 insertions, 8 deletions
diff --git a/lisp/keymap.el b/lisp/keymap.el
index 4f02639ffe2..dccc0a3cd31 100644
--- a/lisp/keymap.el
+++ b/lisp/keymap.el
@@ -579,14 +579,17 @@ value can also be a property list with properties `:enter' and
:repeat (:enter (commands ...) :exit (commands ...))
`:enter' specifies the list of additional commands that only
-enter `repeat-mode'. When the list is empty, then by default all
-commands in the map enter `repeat-mode'. This is useful when
-there is a command that has the `repeat-map' symbol property, but
-doesn't exist in this specific map. `:exit' is a list of
-commands that exit `repeat-mode'. When the list is empty, no
-commands in the map exit `repeat-mode'. This is useful when a
-command exists in this specific map, but it doesn't have the
-`repeat-map' symbol property on its symbol.
+enter `repeat-mode'. When the list is empty, then only the
+commands defined in the map enter `repeat-mode'. Specifying a
+list of commands is useful when there are commands that have the
+`repeat-map' symbol property, but don't exist in this specific
+map.
+
+`:exit' is a list of commands that exit `repeat-mode'. When the
+list is empty, no commands in the map exit `repeat-mode'.
+Specifying a list of commands is useful when those commands exist
+in this specific map, but should not have the `repeat-map' symbol
+property.
\(fn VARIABLE-NAME &key DOC FULL PARENT SUPPRESS NAME PREFIX KEYMAP REPEAT &rest [KEY DEFINITION]...)"
(declare (indent 1))