From: Austin Clements Date: Sun, 6 Oct 2013 03:22:42 +0000 (+2000) Subject: [PATCH 0/6] emacs: Built-in help improvements and clean up doc strings X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=61a7bf5930d43de526093977b3a3aef52c8fdd2a;p=notmuch-archives.git [PATCH 0/6] emacs: Built-in help improvements and clean up doc strings --- diff --git a/a4/9ed15709804c1fdd1fa9d93dd77d4aa6834fc0 b/a4/9ed15709804c1fdd1fa9d93dd77d4aa6834fc0 new file mode 100644 index 000000000..22b5b4fe7 --- /dev/null +++ b/a4/9ed15709804c1fdd1fa9d93dd77d4aa6834fc0 @@ -0,0 +1,94 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id E4078431FC4 + for ; Sat, 5 Oct 2013 20:23:02 -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 PzYc-x82tWsO for ; + Sat, 5 Oct 2013 20:22:56 -0700 (PDT) +Received: from dmz-mailsec-scanner-3.mit.edu (dmz-mailsec-scanner-3.mit.edu + [18.9.25.14]) + by olra.theworths.org (Postfix) with ESMTP id 96DFE431FAF + for ; Sat, 5 Oct 2013 20:22:56 -0700 (PDT) +X-AuditID: 1209190e-b7f828e0000009cf-a9-5250d78ec6bc +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP + id 39.3A.02511.E87D0525; Sat, 5 Oct 2013 23:22:55 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r963MrqA032731 + for ; Sat, 5 Oct 2013 23:22:54 -0400 +Received: from drake.dyndns.org + (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com + [216.15.114.40]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r963MpcB024416 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT) + for ; Sat, 5 Oct 2013 23:22:53 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) id 1VSevj-00037k-Mv + for notmuch@notmuchmail.org; Sat, 05 Oct 2013 23:22:51 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 0/6] emacs: Built-in help improvements and clean up doc + strings +Date: Sat, 5 Oct 2013 23:22:42 -0400 +Message-Id: <1381029768-11883-1-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.8.4.rc3 +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFupnkeLIzCtJLcpLzFFi42IR4hRV1u2/HhBkcGc1o8X1mzOZHRg9nq26 + xRzAGMVlk5Kak1mWWqRvl8CV8XzXUqaCzewVL6/NZmxg/MHaxcjJISFgIrFy4Q8mCFtM4sK9 + 9WxdjFwcQgL7GCUW//rLCOGcY5SYeraVBcL5ySSx6fYNZghnN6PE/+3XmEH62QQ0JLbtX84I + YosISEvsvDsbaAcHh7CAv8TjJ7UgYRYBVYkD91rA1vEKOEjMOfgB6gwliYWntrFOYORZwMiw + ilE2JbdKNzcxM6c4NVm3ODkxLy+1SNdYLzezRC81pXQTI9jfknw7GL8eVDrEKMDBqMTDO9Mn + IEiINbGsuDL3EKMkB5OSKO/0q0AhvqT8lMqMxOKM+KLSnNTiQ4wSHMxKIrwsBUA53pTEyqrU + onyYlDQHi5I4700O+yAhgfTEktTs1NSC1CKYrAwHh5IEb9g1oEbBotT01Iq0zJwShDQTByfI + cB6g4eEgNbzFBYm5xZnpEPlTjIpS4rwJIAkBkERGaR5cLyweXzGKA70izFsBUsUDjGW47ldA + g5mABkdJ+IIMLklESEk1MBao5Je2WdxXFXdysvKNPP3l6YZAjpY8iRDr5n8nXBiW+is68Mbe + ZIhbx/Tn9SsGnjcWp6UEL5rU7Lyaox6QsvpS3lXtvX9efGRYMq209m7kMQ6PvZ7KV2RyU/cd + 5k9lCrTU476is7eo7OXZZQf1lb1Ks/pZWfcsdLRcpKT357pPyzF50T8nlViKMxINtZiLihMB + 8GuvI6ICAAA= +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: Sun, 06 Oct 2013 03:23:03 -0000 + +The first three patches in this series simply fix some function +documentation string problems I found while making the other patches. +I'm marking them trivial because they don't affect any code. + +The rest of this series improves a bunch of the built-in Emacs help, +accessed through `notmuch-help' (bound to "?" by default). In +addition to improving some documentation strings, it introduces a new +facility to `notmuch-help' to explicitly specify interactive +documentation and documentation for prefixed commands. For example, +where notmuch-help currently says + +m Invoke the notmuch mail composition window. + +with this series, it says + +m Compose new mail. +C-u m ... and prompt for sender + +Feel free to point out commands I missed (or post patches for them). +I went through all bound commands in hello, search, and show, as well +as all prefixed commands, but didn't go through unbound, non-prefixed +commands. +