aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemse2014-01-22 21:52:35 +0100
committerGravatar Tom Willemse2014-01-22 21:52:35 +0100
commit6e0bef84ca5cbc5d40a0fb7f26babd3221e016b8 (patch)
tree6ea4b8f5ecfe7fc9c943a781de16b43e378af44b
parent0e79b6f38d79817cfbe93064c7a9ef49ea1039e3 (diff)
downloadtransient-navigation-6e0bef84ca5cbc5d40a0fb7f26babd3221e016b8.tar.gz
transient-navigation-6e0bef84ca5cbc5d40a0fb7f26babd3221e016b8.zip
Add docstrings to variables
-rw-r--r--transient-navigation.el12
1 files changed, 9 insertions, 3 deletions
diff --git a/transient-navigation.el b/transient-navigation.el
index d485174..4bd71c4 100644
--- a/transient-navigation.el
+++ b/transient-navigation.el
@@ -42,9 +42,15 @@
;;; Code:
-(defvar transient-navigation-mode-map (make-sparse-keymap))
-(defvar transient-C-navigation-map (make-sparse-keymap))
-(defvar transient-M-navigation-map (make-sparse-keymap))
+(defvar transient-navigation-mode-map (make-sparse-keymap)
+ "The keymap that will start all the trouble.
+
+The original keybindings will be remapped to the ones enabling
+the transient keymap.")
+(defvar transient-C-navigation-map (make-sparse-keymap)
+ "The keymap containing control-prefixed keys.")
+(defvar transient-M-navigation-map (make-sparse-keymap)
+ "The keymap containing meta-prefixed keys.")
(defmacro transnav-make-transient (key map func)
"Bind KEY in MAP to FUNC with a transient map."