From: W. Trevor King <wking@tremily.us>
Date: Sat, 10 May 2014 17:54:02 +0000 (-0700)
Subject: nmbug-status: Shift the script description into a docstring
X-Git-Tag: nmbug-status-cworth-v1
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=983e6540ad12f69cd5c82a442282e26a4cbf6335;p=notmuch.git

nmbug-status: Shift the script description into a docstring

This way we can use it as the ArgumentParser description (formatted
with 'nmbug-status --help') and script readers still have it near the
top of the file.  I rephrased things a bit to match PEP 257's
summary-line-and-body format [1] while elaborating on the "if
available" Gmane views.

[1]: http://legacy.python.org/dev/peps/pep-0257/#multi-line-docstrings
---

diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index c9cc7452..926d4e4e 100755
--- a/devel/nmbug/nmbug-status
+++ b/devel/nmbug/nmbug-status
@@ -1,8 +1,5 @@
 #!/usr/bin/python
 #
-# Generate an HTML page with the result of one or more notmuch
-# searches, (with links to gmane views of each email if available).
-#
 # Copyright (c) 2011-2012 David Bremner <david@tethera.net>
 #
 # dependencies
@@ -22,6 +19,13 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see http://www.gnu.org/licenses/ .
 
+"""Generate HTML for one or more notmuch searches.
+
+Messages matching each search are grouped by thread.  Each message
+that contains both a subject and message-id will have the displayed
+subject link to the Gmane view of the message.
+"""
+
 from __future__ import print_function
 from __future__ import unicode_literals
 
@@ -258,7 +262,7 @@ class HtmlPage (Page):
     def _slug(self, string):
         return self._slug_regexp.sub('-', string)
 
-parser = argparse.ArgumentParser()
+parser = argparse.ArgumentParser(description=__doc__)
 parser.add_argument('--text', help='output plain text format',
                     action='store_true')
 parser.add_argument('--config', help='load config from given file',