From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 32275431FAF for ; Mon, 7 Oct 2013 15:49:09 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.7 X-Spam-Level: X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id r8r8RkppMl6T for ; Mon, 7 Oct 2013 15:49:03 -0700 (PDT) Received: from dmz-mailsec-scanner-4.mit.edu (dmz-mailsec-scanner-4.mit.edu [18.9.25.15]) by olra.theworths.org (Postfix) with ESMTP id DD715431FAE for ; Mon, 7 Oct 2013 15:49:02 -0700 (PDT) X-AuditID: 1209190f-b7fa08e0000009c6-11-52533a5e106b Received: from mailhub-auth-4.mit.edu ( [18.7.62.39]) by dmz-mailsec-scanner-4.mit.edu (Symantec Messaging Gateway) with SMTP id A1.CB.02502.E5A33525; Mon, 7 Oct 2013 18:49:02 -0400 (EDT) Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id r97Mn020026104; Mon, 7 Oct 2013 18:49:00 -0400 Received: from drake.dyndns.org (26-4-172.dynamic.csail.mit.edu [18.26.4.172]) (authenticated bits=0) (User authenticated as amdragon@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r97Mmxlc001039 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); Mon, 7 Oct 2013 18:49:00 -0400 Received: from amthrax by drake.dyndns.org with local (Exim 4.77) (envelope-from ) id 1VTJbm-0007BG-Gi; Mon, 07 Oct 2013 18:48:58 -0400 From: Austin Clements To: notmuch@notmuchmail.org Subject: [PATCH 7/6] emacs: Improved `notmuch-describe-keymap' documentation Date: Mon, 7 Oct 2013 18:48:51 -0400 Message-Id: <1381186131-27552-1-git-send-email-amdragon@mit.edu> X-Mailer: git-send-email 1.8.4.rc3 In-Reply-To: <1381029768-11883-1-git-send-email-amdragon@mit.edu> References: <1381029768-11883-1-git-send-email-amdragon@mit.edu> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixG6nrhtnFRxk8HSugsX1mzOZHRg9nq26 xRzAGMVlk5Kak1mWWqRvl8CVsfVWI2vBBM6K1fs+sTcwrmfvYuTkkBAwkdi89gUzhC0mceHe erYuRi4OIYF9jBKNi3exQjgbGCWOzT/DAlIlJHCYSWLHKS4Iey6jxPkp0iA2m4CGxLb9yxlB bBEBaYmdd2cDNXNwMAuoSfzpUgEJCwv4SNy8s4ANxGYRUJVoa3kJtphXwEHiwJWHLBBHKEks PLWNFcTmFHCU2HzqDSPEKgeJ68ufM05g5F/AyLCKUTYlt0o3NzEzpzg1Wbc4OTEvL7VI10Qv N7NELzWldBMjKGQ4Jfl3MH47qHSIUYCDUYmHN+NoUJAQa2JZcWXuIUZJDiYlUd4ey+AgIb6k /JTKjMTijPii0pzU4kOMEhzMSiK8AkZAOd6UxMqq1KJ8mJQ0B4uSOO9NDvsgIYH0xJLU7NTU gtQimKwMB4eSBG8kyFDBotT01Iq0zJwShDQTByfIcB6g4fNAaniLCxJzizPTIfKnGBWlxHln gyQEQBIZpXlwvbCYfsUoDvSKMO8OkCoeYDqA634FNJgJaLAueyDI4JJEhJRUA2Mtj6egzNTE oobOfo/cWdc6NfetE2U0Fd4eO/3wb9HDEWLrVqzxOHHxSstnJy0hrSMm7adSzvH0h/08Zh22 iuPGeaf4U08rvJ/s32qS5dXNVmDGz2c6o0vlU2PMraM5+57tD9yRHtfEzqa8qDrb+w6LxSsB JksNx74FTj3F65ba2IfGrHa5o8RSnJFoqMVcVJwIAPJbaN/EAgAA X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 07 Oct 2013 22:49:09 -0000 --- emacs/notmuch.el | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/emacs/notmuch.el b/emacs/notmuch.el index e559472..c47c6b5 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) -- 1.8.4.rc3