aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Austin Clements <amdragon@MIT.EDU>2013-10-07 18:48:51 -0400
committerGravatar David Bremner <bremner@debian.org>2013-10-10 07:42:54 -0300
commit459c5869678161495076f166264a967243c233f4 (patch)
tree02b54a714d103eba71e165d4a1cda5fbcd121783
parent1f5ae4e00f011098bfe6816e05c4f6da710cd371 (diff)
emacs: Improved `notmuch-describe-keymap' documentation
-rw-r--r--emacs/notmuch.el11
1 files changed, 8 insertions, 3 deletions
diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index e5594722..c47c6b56 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -141,10 +141,15 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-."
(concat desc " "))))
(defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail)
- "Return a list of strings, each describing one key in KEYMAP.
+ "Return a list of strings, each describing one binding in KEYMAP.
-Each string gives a human-readable description of the key and the
-first line of documentation for the bound function."
+Each string gives a human-readable description of the key and a
+one-line description of the bound function. See `notmuch-help'
+for an overview of how this documentation is extracted.
+
+UA-KEYS should be a key sequence bound to `universal-argument'.
+It will be used to describe bindings of commands that support a
+prefix argument. PREFIX and TAIL are used internally."
(map-keymap
(lambda (key binding)
(cond ((mouse-event-p key) nil)