From: Austin Clements Date: Sun, 6 Oct 2013 03:22:45 +0000 (+2000) Subject: [PATCH 3/6] emacs: Clean up a few documentation strings X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=b05436ee361656d50acbd3010c274d49a7c4ef31;p=notmuch-archives.git [PATCH 3/6] emacs: Clean up a few documentation strings --- diff --git a/fa/90029bf3cd94ac4666ac1287f7a8c619189d37 b/fa/90029bf3cd94ac4666ac1287f7a8c619189d37 new file mode 100644 index 000000000..06bb61004 --- /dev/null +++ b/fa/90029bf3cd94ac4666ac1287f7a8c619189d37 @@ -0,0 +1,152 @@ +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 2FBC8431FAF + for ; Sat, 5 Oct 2013 20:23:12 -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 IGsXowDg1KuQ for ; + Sat, 5 Oct 2013 20:23:08 -0700 (PDT) +Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu + [18.7.68.35]) + by olra.theworths.org (Postfix) with ESMTP id 69205431FC0 + for ; Sat, 5 Oct 2013 20:22:57 -0700 (PDT) +X-AuditID: 12074423-b7fc98e0000009a2-84-5250d790f4d0 +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP + id 6E.46.02466.097D0525; Sat, 5 Oct 2013 23:22:56 -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 r963MsAw032732; + 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 r963MpkW024419 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Sat, 5 Oct 2013 23:22:53 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1VSevj-00037q-PV; Sat, 05 Oct 2013 23:22:51 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 3/6] emacs: Clean up a few documentation strings +Date: Sat, 5 Oct 2013 23:22:45 -0400 +Message-Id: <1381029768-11883-4-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+NgFtrAIsWRmVeSWpSXmKPExsUixCmqrDvhekCQwZczohbXb85kdmD0eLbq + FnMAYxSXTUpqTmZZapG+XQJXxvUHJ9kKPspUNJ19xtrAuEa8i5GTQ0LARGLWswdMELaYxIV7 + 69m6GLk4hAT2MUo8PzqdHcLZwCixaQ9M5jaTxN+r71kgnLmMEq2L7zGC9LMJaEhs278czBYR + kJbYeXc2axcjBwezgJrEny4VEFNYwEGiZREfiMkioCoxYUM8iMkLFP3whgfiBiWJhae2sYLY + nAKOEptPvQGbJwRUcn35c8YJjPwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrp5WaW6KWm + lG5iBAUMu4vyDsY/B5UOMQpwMCrx8Dp4BQQJsSaWFVfmHmKU5GBSEuWdfhUoxJeUn1KZkVic + EV9UmpNafIhRgoNZSYSXpQAox5uSWFmVWpQPk5LmYFES573FYR8kJJCeWJKanZpakFoEk5Xh + 4FCS4O25BtQoWJSanlqRlplTgpBm4uAEGc4DNHwySA1vcUFibnFmOkT+FKOilDjvbJCEAEgi + ozQPrhcW0a8YxYFeEebdDlLFA0wGcN2vgAYzAQ2OkvAFGVySiJCSamBUjS4qn1f5lvm9Xp3n + LKmUknMqvAdLynU8nrzyviCV93N67xqGnzrluWfu3P2acrmlykcjPjo1Oktmas/9D9p/nTQy + i+8dKAuyOu7y3rOr4mTQ1P0FvFvq3QRnXsx3mXRL9mBUyaUpZf0s7ck5Cypy9coX6wobMllq + ut+KYN25tPzwtQkPLZVYijMSDbWYi4oTAcuf8VzDAgAA +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:12 -0000 + +Correct some grammatical errors, fix some violations of standard +documentation string formatting conventions, and be more precise. +--- + emacs/notmuch-show.el | 18 ++++++++++-------- + emacs/notmuch.el | 10 +++++----- + 2 files changed, 15 insertions(+), 13 deletions(-) + +diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +index 5d7e24b..7758eaf 100644 +--- a/emacs/notmuch-show.el ++++ b/emacs/notmuch-show.el +@@ -1575,7 +1575,7 @@ shown." + (notmuch-show-archive-thread-then-next))) + + (defun notmuch-show-rewind () +- "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]). ++ "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]). + + Specifically, if the beginning of the previous email is fewer + than `window-height' lines from the current point, move to it +@@ -1723,15 +1723,16 @@ to show, nil otherwise." + (view-buffer buf 'kill-buffer-if-not-modified))) + + (defun notmuch-show-pipe-message (entire-thread command) +- "Pipe the contents of the current message (or thread) to the given command. ++ "Pipe the contents of the current message (or thread) to COMMAND. + +-The given command will be executed with the raw contents of the +-current email message as stdin. Anything printed by the command +-to stdout or stderr will appear in the *notmuch-pipe* buffer. ++COMMAND will be executed with the raw contents of the current ++email message as stdin. Anything printed by the command to stdout ++or stderr will appear in the *notmuch-pipe* buffer. + +-When invoked with a prefix argument, the command will receive all +-open messages in the current thread (formatted as an mbox) rather +-than only the current message." ++If ENTIRE-THREAD is non-nil (or when invoked with a prefix ++argument), COMMAND will receive all open messages in the current ++thread (formatted as an mbox) rather than only the current ++message." + (interactive (let ((query-string (if current-prefix-arg + "Pipe all open messages to command: " + "Pipe message to command: "))) +@@ -1823,6 +1824,7 @@ See `notmuch-tag' for information on the format of TAG-CHANGES." + + (defun notmuch-show-open-or-close-all () + "Set the visibility all of the messages in the current thread. ++ + By default make all of the messages visible. With a prefix + argument, hide all of the messages." + (interactive) +diff --git a/emacs/notmuch.el b/emacs/notmuch.el +index 0ff248b..a36849f 100644 +--- a/emacs/notmuch.el ++++ b/emacs/notmuch.el +@@ -869,15 +869,15 @@ PROMPT is the string to prompt with." + + ;;;###autoload + (defun notmuch-search (&optional query oldest-first target-thread target-line) +- "Run \"notmuch search\" with the given `query' and display results. ++ "Display threads matching QUERY in a notmuch-search buffer. + +-If `query' is nil, it is read interactively from the minibuffer. ++If QUERY is nil, it is read interactively from the minibuffer. + Other optional parameters are used as follows: + +- oldest-first: A Boolean controlling the sort order of returned threads +- target-thread: A thread ID (without the thread: prefix) that will be made ++ OLDEST-FIRST: A Boolean controlling the sort order of returned threads ++ TARGET-THREAD: A thread ID (without the thread: prefix) that will be made + current if it appears in the search results. +- target-line: The line number to move to if the target thread does not ++ TARGET-LINE: The line number to move to if the target thread does not + appear in the search results. + + When called interactively, this will prompt for a query and use +-- +1.8.4.rc3 +