emacs: Improved `notmuch-describe-keymap' documentation

This commit is contained in:
Austin Clements 2013-10-07 18:48:51 -04:00 committed by David Bremner
parent 1f5ae4e00f
commit 459c586967

View file

@ -141,10 +141,15 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-."
(concat desc " ")))) (concat desc " "))))
(defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail) (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 Each string gives a human-readable description of the key and a
first line of documentation for the bound function." 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 (map-keymap
(lambda (key binding) (lambda (key binding)
(cond ((mouse-event-p key) nil) (cond ((mouse-event-p key) nil)