fa/90029bf3cd94ac4666ac1287f7a8c619189d37

   1 Return-Path: <amdragon@mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 2FBC8431FAF\r
   6         for <notmuch@notmuchmail.org>; Sat,  5 Oct 2013 20:23:12 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id IGsXowDg1KuQ for <notmuch@notmuchmail.org>;\r
  16         Sat,  5 Oct 2013 20:23:08 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu\r
  18         [18.7.68.35])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 69205431FC0\r
  20         for <notmuch@notmuchmail.org>; Sat,  5 Oct 2013 20:22:57 -0700 (PDT)\r
  21 X-AuditID: 12074423-b7fc98e0000009a2-84-5250d790f4d0\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id 6E.46.02466.097D0525; Sat,  5 Oct 2013 23:22:56 -0400 (EDT)\r
  25 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  26         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id r963MsAw032732; \r
  27         Sat, 5 Oct 2013 23:22:54 -0400\r
  28 Received: from drake.dyndns.org\r
  29         (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  30         [216.15.114.40]) (authenticated bits=0)\r
  31         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  32         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r963MpkW024419\r
  33         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  34         Sat, 5 Oct 2013 23:22:53 -0400\r
  35 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  36         (envelope-from <amdragon@mit.edu>)\r
  37         id 1VSevj-00037q-PV; Sat, 05 Oct 2013 23:22:51 -0400\r
  38 From: Austin Clements <amdragon@MIT.EDU>\r
  39 To: notmuch@notmuchmail.org\r
  40 Subject: [PATCH 3/6] emacs: Clean up a few documentation strings\r
  41 Date: Sat,  5 Oct 2013 23:22:45 -0400\r
  42 Message-Id: <1381029768-11883-4-git-send-email-amdragon@mit.edu>\r
  43 X-Mailer: git-send-email 1.8.4.rc3\r
  44 In-Reply-To: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
  45 References: <1381029768-11883-1-git-send-email-amdragon@mit.edu>\r
  46 X-Brightmail-Tracker:\r
  47  H4sIAAAAAAAAA+NgFtrAIsWRmVeSWpSXmKPExsUixCmqrDvhekCQwZczohbXb85kdmD0eLbq\r
  48         FnMAYxSXTUpqTmZZapG+XQJXxvUHJ9kKPspUNJ19xtrAuEa8i5GTQ0LARGLWswdMELaYxIV7\r
  49         69m6GLk4hAT2MUo8PzqdHcLZwCixaQ9M5jaTxN+r71kgnLmMEq2L7zGC9LMJaEhs278czBYR\r
  50         kJbYeXc2axcjBwezgJrEny4VEFNYwEGiZREfiMkioCoxYUM8iMkLFP3whgfiBiWJhae2sYLY\r
  51         nAKOEptPvQGbJwRUcn35c8YJjPwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrp5WaW6KWm\r
  52         lG5iBAUMu4vyDsY/B5UOMQpwMCrx8Dp4BQQJsSaWFVfmHmKU5GBSEuWdfhUoxJeUn1KZkVic\r
  53         EV9UmpNafIhRgoNZSYSXpQAox5uSWFmVWpQPk5LmYFES573FYR8kJJCeWJKanZpakFoEk5Xh\r
  54         4FCS4O25BtQoWJSanlqRlplTgpBm4uAEGc4DNHwySA1vcUFibnFmOkT+FKOilDjvbJCEAEgi\r
  55         ozQPrhcW0a8YxYFeEebdDlLFA0wGcN2vgAYzAQ2OkvAFGVySiJCSamBUjS4qn1f5lvm9Xp3n\r
  56         LKmUknMqvAdLynU8nrzyviCV93N67xqGnzrluWfu3P2acrmlykcjPjo1Oktmas/9D9p/nTQy\r
  57         i+8dKAuyOu7y3rOr4mTQ1P0FvFvq3QRnXsx3mXRL9mBUyaUpZf0s7ck5Cypy9coX6wobMllq\r
  58         ut+KYN25tPzwtQkPLZVYijMSDbWYi4oTAcuf8VzDAgAA\r
  59 X-BeenThere: notmuch@notmuchmail.org\r
  60 X-Mailman-Version: 2.1.13\r
  61 Precedence: list\r
  62 List-Id: "Use and development of the notmuch mail system."\r
  63         <notmuch.notmuchmail.org>\r
  64 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  65         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  66 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  67 List-Post: <mailto:notmuch@notmuchmail.org>\r
  68 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  69 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  70         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  71 X-List-Received-Date: Sun, 06 Oct 2013 03:23:12 -0000\r
  72 \r
  73 Correct some grammatical errors, fix some violations of standard\r
  74 documentation string formatting conventions, and be more precise.\r
  75 ---\r
  76  emacs/notmuch-show.el | 18 ++++++++++--------\r
  77  emacs/notmuch.el      | 10 +++++-----\r
  78  2 files changed, 15 insertions(+), 13 deletions(-)\r
  79 \r
  80 diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
  81 index 5d7e24b..7758eaf 100644\r
  82 --- a/emacs/notmuch-show.el\r
  83 +++ b/emacs/notmuch-show.el\r
  84 @@ -1575,7 +1575,7 @@ shown."\r
  85        (notmuch-show-archive-thread-then-next)))\r
  86  \r
  87  (defun notmuch-show-rewind ()\r
  88 -  "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).\r
  89 +  "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).\r
  90  \r
  91  Specifically, if the beginning of the previous email is fewer\r
  92  than `window-height' lines from the current point, move to it\r
  93 @@ -1723,15 +1723,16 @@ to show, nil otherwise."\r
  94      (view-buffer buf 'kill-buffer-if-not-modified)))\r
  95  \r
  96  (defun notmuch-show-pipe-message (entire-thread command)\r
  97 -  "Pipe the contents of the current message (or thread) to the given command.\r
  98 +  "Pipe the contents of the current message (or thread) to COMMAND.\r
  99  \r
 100 -The given command will be executed with the raw contents of the\r
 101 -current email message as stdin. Anything printed by the command\r
 102 -to stdout or stderr will appear in the *notmuch-pipe* buffer.\r
 103 +COMMAND will be executed with the raw contents of the current\r
 104 +email message as stdin. Anything printed by the command to stdout\r
 105 +or stderr will appear in the *notmuch-pipe* buffer.\r
 106  \r
 107 -When invoked with a prefix argument, the command will receive all\r
 108 -open messages in the current thread (formatted as an mbox) rather\r
 109 -than only the current message."\r
 110 +If ENTIRE-THREAD is non-nil (or when invoked with a prefix\r
 111 +argument), COMMAND will receive all open messages in the current\r
 112 +thread (formatted as an mbox) rather than only the current\r
 113 +message."\r
 114    (interactive (let ((query-string (if current-prefix-arg\r
 115                                        "Pipe all open messages to command: "\r
 116                                      "Pipe message to command: ")))\r
 117 @@ -1823,6 +1824,7 @@ See `notmuch-tag' for information on the format of TAG-CHANGES."\r
 118  \r
 119  (defun notmuch-show-open-or-close-all ()\r
 120    "Set the visibility all of the messages in the current thread.\r
 121 +\r
 122  By default make all of the messages visible. With a prefix\r
 123  argument, hide all of the messages."\r
 124    (interactive)\r
 125 diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
 126 index 0ff248b..a36849f 100644\r
 127 --- a/emacs/notmuch.el\r
 128 +++ b/emacs/notmuch.el\r
 129 @@ -869,15 +869,15 @@ PROMPT is the string to prompt with."\r
 130  \r
 131  ;;;###autoload\r
 132  (defun notmuch-search (&optional query oldest-first target-thread target-line)\r
 133 -  "Run \"notmuch search\" with the given `query' and display results.\r
 134 +  "Display threads matching QUERY in a notmuch-search buffer.\r
 135  \r
 136 -If `query' is nil, it is read interactively from the minibuffer.\r
 137 +If QUERY is nil, it is read interactively from the minibuffer.\r
 138  Other optional parameters are used as follows:\r
 139  \r
 140 -  oldest-first: A Boolean controlling the sort order of returned threads\r
 141 -  target-thread: A thread ID (without the thread: prefix) that will be made\r
 142 +  OLDEST-FIRST: A Boolean controlling the sort order of returned threads\r
 143 +  TARGET-THREAD: A thread ID (without the thread: prefix) that will be made\r
 144                   current if it appears in the search results.\r
 145 -  target-line: The line number to move to if the target thread does not\r
 146 +  TARGET-LINE: The line number to move to if the target thread does not\r
 147                 appear in the search results.\r
 148  \r
 149  When called interactively, this will prompt for a query and use\r
 150 -- \r
 151 1.8.4.rc3\r
 152 \r