aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Pluim2023-03-20 09:44:33 +0100
committerRobert Pluim2023-03-20 09:47:32 +0100
commiteed240bc022cef4ef0f2b12bd2ff116eb6b9581d (patch)
tree783edac1593ac20ef8220e9b3ec24ccb4c3b1b70
parentb7f03333551b2214f4d151d25d319e62402167c1 (diff)
downloademacs-eed240bc022cef4ef0f2b12bd2ff116eb6b9581d.tar.gz
emacs-eed240bc022cef4ef0f2b12bd2ff116eb6b9581d.zip
Improve defvar-keymap docstring.
* lisp/keymap.el (defvar-keymap): Improve description of ':enter' and ':exit' usage for ':repeat' keyword.
-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
579 :repeat (:enter (commands ...) :exit (commands ...)) 579 :repeat (:enter (commands ...) :exit (commands ...))
580 580
581`:enter' specifies the list of additional commands that only 581`:enter' specifies the list of additional commands that only
582enter `repeat-mode'. When the list is empty, then by default all 582enter `repeat-mode'. When the list is empty, then only the
583commands in the map enter `repeat-mode'. This is useful when 583commands defined in the map enter `repeat-mode'. Specifying a
584there is a command that has the `repeat-map' symbol property, but 584list of commands is useful when there are commands that have the
585doesn't exist in this specific map. `:exit' is a list of 585`repeat-map' symbol property, but don't exist in this specific
586commands that exit `repeat-mode'. When the list is empty, no 586map.
587commands in the map exit `repeat-mode'. This is useful when a 587
588command exists in this specific map, but it doesn't have the 588`:exit' is a list of commands that exit `repeat-mode'. When the
589`repeat-map' symbol property on its symbol. 589list is empty, no commands in the map exit `repeat-mode'.
590Specifying a list of commands is useful when those commands exist
591in this specific map, but should not have the `repeat-map' symbol
592property.
590 593
591\(fn VARIABLE-NAME &key DOC FULL PARENT SUPPRESS NAME PREFIX KEYMAP REPEAT &rest [KEY DEFINITION]...)" 594\(fn VARIABLE-NAME &key DOC FULL PARENT SUPPRESS NAME PREFIX KEYMAP REPEAT &rest [KEY DEFINITION]...)"
592 (declare (indent 1)) 595 (declare (indent 1))