Improved documentation

[mpd-sima.git] / sima / utils / startopt.py

diff --git a/sima/utils/startopt.py b/sima/utils/startopt.py
index 84cd4e74be3dbfeb0ed25f4ec34f6f6e9f08de5e..51319f60afc7360b3a5d64d8993ec6e29c1cdeee 100644 (file)
--- a/sima/utils/startopt.py
+++ b/sima/utils/startopt.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2010, 2011, 2012, 2013 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
 #
 #  This file is part of sima
 #
@@ -19,18 +19,14 @@
 #
 #
 
-import sys
 from argparse import (ArgumentParser, SUPPRESS)
 
 
-from .utils import Obsolete, Wfile, Rfile, Wdir
+from .utils import Wfile, Rfile, Wdir
 
-USAGE = """USAGE:  %prog [--help] [options]"""
 DESCRIPTION = """
-sima automagicaly queue new tracks in MPD playlist.
-All command line options will override their equivalent in configuration
-file.
-"""
+MPD_sima automagicaly queue new tracks in MPD playlist.
+Command line options override their equivalent in configuration file."""
 
 
 def clean_dict(to_clean):
@@ -60,7 +56,7 @@ OPTS = [
         'type': str,
         'dest': 'verbosity',
         'choices': ['debug', 'info', 'warning', 'error'],
-        'help': 'file to log message to, default is stdout/stderr'},
+        'help': 'Log messages verbosity, default is info'},
     {
         'sw': ['-p', '--pid'],
         'dest': 'pidfile',
@@ -115,6 +111,7 @@ class StartOpt(object):
     """
 
     def __init__(self, script_info,):
+        self.parser = None
         self.info = dict(script_info)
         self.options = dict()
         self.main()
@@ -124,12 +121,11 @@ class StartOpt(object):
         Declare options in ArgumentParser object.
         """
         self.parser = ArgumentParser(description=DESCRIPTION,
-                                   usage='%(prog)s [options]',
-                                   prog=self.info.get('prog'),
-                                   epilog='Happy Listening',
-                )
+                                     prog=self.info.get('prog'),
+                                     epilog='Happy Listening',
+                                    )
         self.parser.add_argument('--version', action='version',
-                version='%(prog)s {version}'.format(**self.info))
+                        version='%(prog)s {version}'.format(**self.info))
         # Add all options declare in OPTS
         for opt in OPTS:
             opt_names = opt.pop('sw')