summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThanos Apollo <public@thanosapollo.org>2026-04-30 06:29:21 +0300
committerThanos Apollo <public@thanosapollo.org>2026-04-30 06:29:21 +0300
commit43796a7a722db9fc90af61c53383635fa763eec1 (patch)
tree4fb95be06a0c27d0449e53dc152213ed00a766ab
parentab61c25601691c290253784ee4e3494d1fde0e87 (diff)
docs: clarify defcustom and annotate keyword defaults in docstrings
-rw-r--r--keymap-popup.el16
1 files changed, 14 insertions, 2 deletions
diff --git a/keymap-popup.el b/keymap-popup.el
index d507799..85bcbee 100644
--- a/keymap-popup.el
+++ b/keymap-popup.el
@@ -86,12 +86,18 @@ visibility) when creating the child frame."
:group 'keymap-popup)
(defcustom keymap-popup-default-popup-key "h"
- "Default key to open the popup in keymaps defined with `keymap-popup-define'."
+ "Default key to open the popup in keymaps defined with `keymap-popup-define'.
+Applied automatically by `keymap-popup-define' when :popup-key is
+not specified. Not applied by `keymap-popup-annotate' (must be
+given explicitly)."
:type 'string
:group 'keymap-popup)
(defcustom keymap-popup-default-exit-key "q"
- "Default key to dismiss the popup."
+ "Default key to dismiss the popup.
+Applied automatically by `keymap-popup-define' when :exit-key is
+not specified. For `keymap-popup-annotate', used as runtime
+fallback when :exit-key is omitted."
:type 'string
:group 'keymap-popup)
@@ -378,6 +384,12 @@ BODY is optional :popup-key KEY, optional :exit-key KEY, optional
COMMAND-SYMBOL DESCRIPTION pairs.
COMMAND-SYMBOL is a function symbol already bound in the keymap.
DESCRIPTION is a string or (STRING &rest PROPS).
+
+Unlike `keymap-popup-define', no defaults are applied for
+:popup-key or :exit-key. Only explicitly provided values take
+effect. When :exit-key is omitted, the popup falls back to
+`keymap-popup-default-exit-key' at display time.
+
Keys are resolved dynamically via `where-is-internal' at display
time, so the popup always reflects the user's current bindings."
(declare (indent 1))