From: "W. Trevor King" <wking@tremily.us>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 2/6] Add a docstring describing the program
Date: Sat, 31 May 2014 15:20:23 -0700
Message-Id:
 <3fd7775920639484fafb788dee39db32c63d9ea0.1401574293.git.wking@tremily.us>
In-Reply-To: <cover.1401574293.git.wking@tremily.us>
References: <cover.1401574293.git.wking@tremily.us>
In-Reply-To: <cover.1401574293.git.wking@tremily.us>
References: <cover.1401574293.git.wking@tremily.us>
Cc: Tomi Ollila <tomi.ollila@iki.fi>
Precedence: list

From: Carl Worth <cworth@cworth.org>

Prefer a docstring to a header comment so we can use it as the
ArgumentParser description (formatted with 'nmbug-status --help').
Script readers still have it near the top of the file.  Since it's a
docstring, use PEP 257's summary-line-and-body format [1].

[1]: http://legacy.python.org/dev/peps/pep-0257/#multi-line-docstrings
---
 devel/nmbug/nmbug-status | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index a7c7920..e137a90 100755
--- a/devel/nmbug/nmbug-status
+++ b/devel/nmbug/nmbug-status
@@ -19,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
 
@@ -255,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',
-- 
1.9.1.353.gc66d89d