From 459c5869678161495076f166264a967243c233f4 Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Mon, 7 Oct 2013 18:48:51 -0400 Subject: [PATCH] emacs: Improved `notmuch-describe-keymap' documentation --- emacs/notmuch.el | 11 ++++++++--- 1 file 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)