aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Carl Worth <cworth@cworth.org>2014-05-31 15:20:23 -0700
committerGravatar David Bremner <david@tethera.net>2014-07-15 20:07:06 -0300
commitb5bdf5f4a83357efd874140f21cef27ef744bea2 (patch)
treef67b3ecc166a9b8e8501c5443c9886518d47dd5b
parentd1d84cab1df3e280676553b057d7c59199b382ea (diff)
Add a docstring describing the program
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
-rwxr-xr-xdevel/nmbug/nmbug-status9
1 files changed, 8 insertions, 1 deletions
diff --git a/devel/nmbug/nmbug-status b/devel/nmbug/nmbug-status
index a7c79206..e137a90e 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',