--- /dev/null
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 2FBC8431FAF\r
+ for <notmuch@notmuchmail.org>; Sat, 5 Oct 2013 20:23:12 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id IGsXowDg1KuQ for <notmuch@notmuchmail.org>;\r
+ Sat, 5 Oct 2013 20:23:08 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu\r
+ [18.7.68.35])\r
+ by olra.theworths.org (Postfix) with ESMTP id 69205431FC0\r
+ for <notmuch@notmuchmail.org>; Sat, 5 Oct 2013 20:22:57 -0700 (PDT)\r
+X-AuditID: 12074423-b7fc98e0000009a2-84-5250d790f4d0\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+ by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
+ id 6E.46.02466.097D0525; Sat, 5 Oct 2013 23:22:56 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+ by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r963MsAw032732; \r
+ Sat, 5 Oct 2013 23:22:54 -0400\r
+Received: from drake.dyndns.org\r
+ (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+ [216.15.114.40]) (authenticated bits=0)\r
+ (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+ by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r963MpkW024419\r
+ (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+ Sat, 5 Oct 2013 23:22:53 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+ (envelope-from <amdragon@mit.edu>)\r
+ id 1VSevj-00037q-PV; Sat, 05 Oct 2013 23:22:51 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 3/6] emacs: Clean up a few documentation strings\r
+Date: Sat, 5 Oct 2013 23:22:45 -0400\r
+Message-Id: <1381029768-11883-4-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
+References: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrAIsWRmVeSWpSXmKPExsUixCmqrDvhekCQwZczohbXb85kdmD0eLbq\r
+ FnMAYxSXTUpqTmZZapG+XQJXxvUHJ9kKPspUNJ19xtrAuEa8i5GTQ0LARGLWswdMELaYxIV7\r
+ 69m6GLk4hAT2MUo8PzqdHcLZwCixaQ9M5jaTxN+r71kgnLmMEq2L7zGC9LMJaEhs278czBYR\r
+ kJbYeXc2axcjBwezgJrEny4VEFNYwEGiZREfiMkioCoxYUM8iMkLFP3whgfiBiWJhae2sYLY\r
+ nAKOEptPvQGbJwRUcn35c8YJjPwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrp5WaW6KWm\r
+ lG5iBAUMu4vyDsY/B5UOMQpwMCrx8Dp4BQQJsSaWFVfmHmKU5GBSEuWdfhUoxJeUn1KZkVic\r
+ EV9UmpNafIhRgoNZSYSXpQAox5uSWFmVWpQPk5LmYFES573FYR8kJJCeWJKanZpakFoEk5Xh\r
+ 4FCS4O25BtQoWJSanlqRlplTgpBm4uAEGc4DNHwySA1vcUFibnFmOkT+FKOilDjvbJCEAEgi\r
+ ozQPrhcW0a8YxYFeEebdDlLFA0wGcN2vgAYzAQ2OkvAFGVySiJCSamBUjS4qn1f5lvm9Xp3n\r
+ LKmUknMqvAdLynU8nrzyviCV93N67xqGnzrluWfu3P2acrmlykcjPjo1Oktmas/9D9p/nTQy\r
+ i+8dKAuyOu7y3rOr4mTQ1P0FvFvq3QRnXsx3mXRL9mBUyaUpZf0s7ck5Cypy9coX6wobMllq\r
+ ut+KYN25tPzwtQkPLZVYijMSDbWYi4oTAcuf8VzDAgAA\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 06 Oct 2013 03:23:12 -0000\r
+\r
+Correct some grammatical errors, fix some violations of standard\r
+documentation string formatting conventions, and be more precise.\r
+---\r
+ emacs/notmuch-show.el | 18 ++++++++++--------\r
+ emacs/notmuch.el | 10 +++++-----\r
+ 2 files changed, 15 insertions(+), 13 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+index 5d7e24b..7758eaf 100644\r
+--- a/emacs/notmuch-show.el\r
++++ b/emacs/notmuch-show.el\r
+@@ -1575,7 +1575,7 @@ shown."\r
+ (notmuch-show-archive-thread-then-next)))\r
+ \r
+ (defun notmuch-show-rewind ()\r
+- "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).\r
++ "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).\r
+ \r
+ Specifically, if the beginning of the previous email is fewer\r
+ than `window-height' lines from the current point, move to it\r
+@@ -1723,15 +1723,16 @@ to show, nil otherwise."\r
+ (view-buffer buf 'kill-buffer-if-not-modified)))\r
+ \r
+ (defun notmuch-show-pipe-message (entire-thread command)\r
+- "Pipe the contents of the current message (or thread) to the given command.\r
++ "Pipe the contents of the current message (or thread) to COMMAND.\r
+ \r
+-The given command will be executed with the raw contents of the\r
+-current email message as stdin. Anything printed by the command\r
+-to stdout or stderr will appear in the *notmuch-pipe* buffer.\r
++COMMAND will be executed with the raw contents of the current\r
++email message as stdin. Anything printed by the command to stdout\r
++or stderr will appear in the *notmuch-pipe* buffer.\r
+ \r
+-When invoked with a prefix argument, the command will receive all\r
+-open messages in the current thread (formatted as an mbox) rather\r
+-than only the current message."\r
++If ENTIRE-THREAD is non-nil (or when invoked with a prefix\r
++argument), COMMAND will receive all open messages in the current\r
++thread (formatted as an mbox) rather than only the current\r
++message."\r
+ (interactive (let ((query-string (if current-prefix-arg\r
+ "Pipe all open messages to command: "\r
+ "Pipe message to command: ")))\r
+@@ -1823,6 +1824,7 @@ See `notmuch-tag' for information on the format of TAG-CHANGES."\r
+ \r
+ (defun notmuch-show-open-or-close-all ()\r
+ "Set the visibility all of the messages in the current thread.\r
++\r
+ By default make all of the messages visible. With a prefix\r
+ argument, hide all of the messages."\r
+ (interactive)\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index 0ff248b..a36849f 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -869,15 +869,15 @@ PROMPT is the string to prompt with."\r
+ \r
+ ;;;###autoload\r
+ (defun notmuch-search (&optional query oldest-first target-thread target-line)\r
+- "Run \"notmuch search\" with the given `query' and display results.\r
++ "Display threads matching QUERY in a notmuch-search buffer.\r
+ \r
+-If `query' is nil, it is read interactively from the minibuffer.\r
++If QUERY is nil, it is read interactively from the minibuffer.\r
+ Other optional parameters are used as follows:\r
+ \r
+- oldest-first: A Boolean controlling the sort order of returned threads\r
+- target-thread: A thread ID (without the thread: prefix) that will be made\r
++ OLDEST-FIRST: A Boolean controlling the sort order of returned threads\r
++ TARGET-THREAD: A thread ID (without the thread: prefix) that will be made\r
+ current if it appears in the search results.\r
+- target-line: The line number to move to if the target thread does not\r
++ TARGET-LINE: The line number to move to if the target thread does not\r
+ appear in the search results.\r
+ \r
+ When called interactively, this will prompt for a query and use\r
+-- \r
+1.8.4.rc3\r
+\r
projects / notmuch-archives.git / commitdiff