[PATCH 5/5] nmbug-status: Shift the script description into a docstring

diff --git a/4a/b482a6651d6d6d26efd56015335d6b4d42ed40 b/4a/b482a6651d6d6d26efd56015335d6b4d42ed40
new file mode 100644 (file)
index 0000000..e283ccd
--- /dev/null
+++ b/4a/b482a6651d6d6d26efd56015335d6b4d42ed40
@@ -0,0 +1,120 @@
+Return-Path: <wking@tremily.us>\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 2FB20429E26\r
+       for <notmuch@notmuchmail.org>; Sat, 10 May 2014 12:13:56 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001]\r
+       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 nYgVbRFFCKqA for <notmuch@notmuchmail.org>;\r
+       Sat, 10 May 2014 12:13:48 -0700 (PDT)\r
+Received: from qmta08.westchester.pa.mail.comcast.net\r
+       (qmta08.westchester.pa.mail.comcast.net [76.96.62.80])\r
+       by olra.theworths.org (Postfix) with ESMTP id 4A278431FC7\r
+       for <notmuch@notmuchmail.org>; Sat, 10 May 2014 12:13:34 -0700 (PDT)\r
+Received: from omta20.westchester.pa.mail.comcast.net ([76.96.62.71])\r
+       by qmta08.westchester.pa.mail.comcast.net with comcast\r
+       id 0K6m1o0031YDfWL58KDW9e; Sat, 10 May 2014 19:13:30 +0000\r
+Received: from odin.tremily.us ([24.18.63.50])\r
+       by omta20.westchester.pa.mail.comcast.net with comcast\r
+       id 0KDV1o00N152l3L3gKDWwU; Sat, 10 May 2014 19:13:30 +0000\r
+Received: from mjolnir.tremily.us (unknown [192.168.0.140])\r
+       by odin.tremily.us (Postfix) with ESMTPS id 233C6119F47B;\r
+       Sat, 10 May 2014 12:13:29 -0700 (PDT)\r
+Received: (nullmailer pid 7441 invoked by uid 1000);\r
+       Sat, 10 May 2014 19:12:55 -0000\r
+From: "W. Trevor King" <wking@tremily.us>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 5/5] nmbug-status: Shift the script description into a\r
+       docstring\r
+Date: Sat, 10 May 2014 12:12:49 -0700\r
+Message-Id:\r
+ <983e6540ad12f69cd5c82a442282e26a4cbf6335.1399748615.git.wking@tremily.us>\r
+X-Mailer: git-send-email 1.9.1.353.gc66d89d\r
+In-Reply-To: <cover.1399748615.git.wking@tremily.us>\r
+References: <cover.1399748615.git.wking@tremily.us>\r
+In-Reply-To: <cover.1399748615.git.wking@tremily.us>\r
+References: <cover.1399748615.git.wking@tremily.us>\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=comcast.net;\r
+       s=q20140121; t=1399749210;\r
+       bh=bz4oE7HbPJE1smC/TZszPDNsONZ8HVvk5yzL4IbISUU=;\r
+       h=Received:Received:Received:Received:From:To:Subject:Date:\r
+       Message-Id;\r
+       b=hawBnwEfTFmArzs3vHuKw6TrIToLrRdfW2DORd2jlhDleE8ZeMDlrOn4YaWANFfSh\r
+       8GAE16iIDyghR0dIT0119HD9dRJsGA2ofEimUOOhV/UrRas22K2rk1xkuyEsi4HF02\r
+       NdRefTYm1MivgC5E5dW+S8obLJWAkxppE4SpWYN43T0nT8aQveHVVHymnvuOwm5rvu\r
+       SGbWXjITPut9XQ6TFLThSNUhAmzKT1/l+4zc2IfPm/vtO+u2ZPpVl1Y3lqp44C9MlI\r
+       AmT6Ell/KbCm7dKm1pRPKkF8O8xK45//kPfWXkTGkh8DLiwDJ2fRETz1Ihjw7Qs8PU\r
+       KBn59HjeGbqEA==\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: Sat, 10 May 2014 19:13:56 -0000\r
+\r
+This way we can use it as the ArgumentParser description (formatted\r
+with 'nmbug-status --help') and script readers still have it near the\r
+top of the file.  I rephrased things a bit to match PEP 257's\r
+summary-line-and-body format [1] while elaborating on the "if\r
+available" Gmane views.\r
+\r
+[1]: http://legacy.python.org/dev/peps/pep-0257/#multi-line-docstrings\r
+---\r
+ devel/nmbug/nmbug-status | 12 ++++++++----\r
+ 1 file changed, 8 insertions(+), 4 deletions(-)\r
+\r
+diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status\r
+index c9cc745..926d4e4 100755\r
+--- a/devel/nmbug/nmbug-status\r
++++ b/devel/nmbug/nmbug-status\r
+@@ -1,8 +1,5 @@\r
+ #!/usr/bin/python\r
+ #\r
+-# Generate an HTML page with the result of one or more notmuch\r
+-# searches, (with links to gmane views of each email if available).\r
+-#\r
+ # Copyright (c) 2011-2012 David Bremner <david@tethera.net>\r
+ #\r
+ # dependencies\r
+@@ -22,6 +19,13 @@\r
+ # You should have received a copy of the GNU General Public License\r
+ # along with this program.  If not, see http://www.gnu.org/licenses/ .\r
+ \r
++"""Generate HTML for one or more notmuch searches.\r
++\r
++Messages matching each search are grouped by thread.  Each message\r
++that contains both a subject and message-id will have the displayed\r
++subject link to the Gmane view of the message.\r
++"""\r
++\r
+ from __future__ import print_function\r
+ from __future__ import unicode_literals\r
+ \r
+@@ -258,7 +262,7 @@ class HtmlPage (Page):\r
+     def _slug(self, string):\r
+         return self._slug_regexp.sub('-', string)\r
+ \r
+-parser = argparse.ArgumentParser()\r
++parser = argparse.ArgumentParser(description=__doc__)\r
+ parser.add_argument('--text', help='output plain text format',\r
+                     action='store_true')\r
+ parser.add_argument('--config', help='load config from given file',\r
+-- \r
+1.9.1.353.gc66d89d\r
+\r