Replace hardcoded default values in help text with real value.

eerimoq · May 9, 2019 · d0eeb99 · d0eeb99
1 parent 31b0272
commit d0eeb99
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 15 deletions.
diff --git a/README.rst b/README.rst
@@ -103,6 +103,16 @@ The menu at the bottom of the monitor shows the available commands.
 
 - Play/Pause: Toggle between playing and paused (or running and freezed).
 
+Broker
+^^^^^^
+
+Start a broker to serve clients.
+
+.. code-block:: text
+
+   $ mqttools broker
+   Starting a broker at 'localhost:1883'.
+
 Scripting
 ---------
 

diff --git a/mqttools/subparsers/broker.py b/mqttools/subparsers/broker.py
@@ -18,10 +18,10 @@ def add_subparser(subparsers):
     subparser = subparsers.add_parser('broker',
                                       description='A simple broker.')
     subparser.add_argument('--host',
-                           default='',
-                           help="Broker host (default: '').")
+                           default='localhost',
+                           help="Broker host (default: %(default)s).")
     subparser.add_argument('--port',
                            type=int,
                            default=1883,
-                           help='Broker port (default: 1883).')
+                           help='Broker port (default: %(default)s).')
     subparser.set_defaults(func=_do_broker)
diff --git a/mqttools/subparsers/monitor.py b/mqttools/subparsers/monitor.py
@@ -220,18 +220,19 @@ def add_subparser(subparsers):
                                       description='Monitor given topics.')
     subparser.add_argument('--host',
                            default='broker.hivemq.com',
-                           help='Broker host (default: broker.hivemq.com).')
+                           help='Broker host (default: %(default)s).')
     subparser.add_argument('--port',
                            type=int,
                            default=1883,
-                           help='Broker port (default: 1883).')
+                           help='Broker port (default: %(default)s).')
     subparser.add_argument('--client-id',
                            help='Client id (default: mqttools-<UUID[0..14]>).')
     subparser.add_argument('--keep-alive',
                            type=int,
                            default=0,
-                           help=('Keep alive time in seconds (default: 0). Give '
-                                 'as 0 to disable keep alive.'))
+                           help=('Keep alive time in seconds (default: '
+                                 '%(default)s). Give as 0 to disable keep '
+                                 'alive.'))
     subparser.add_argument(
         'subscribe',
         nargs='*',

diff --git a/mqttools/subparsers/publish.py b/mqttools/subparsers/publish.py
@@ -53,23 +53,23 @@ def add_subparser(subparsers):
                                       description='Publish given topic.')
     subparser.add_argument('--host',
                            default='broker.hivemq.com',
-                           help='Broker host (default: broker.hivemq.com).')
+                           help='Broker host (default: %(default)s).')
     subparser.add_argument('--port',
                            type=int,
                            default=1883,
-                           help='Broker port (default: 1883).')
+                           help='Broker port (default: %(default)s).')
     subparser.add_argument('--client-id',
                            help='Client id (default: mqttools-<UUID[0..14]>).')
     subparser.add_argument(
         '--count',
         type=int,
         default=1,
-        help='Number of times to publish the message (default: 1).')
+        help='Number of times to publish the message (default: %(default)s).')
     subparser.add_argument(
         '--size',
         type=int,
         default=10,
-        help='Generated message size (default: 10).')
+        help='Generated message size (default: %(default)s).')
     subparser.add_argument('topic', help='Topic to publish.')
     subparser.add_argument(
         'message',

diff --git a/mqttools/subparsers/subscribe.py b/mqttools/subparsers/subscribe.py
@@ -38,17 +38,18 @@ def add_subparser(subparsers):
                                       description='Subscribe for given topic.')
     subparser.add_argument('--host',
                            default='broker.hivemq.com',
-                           help='Broker host (default: broker.hivemq.com).')
+                           help='Broker host (default: %(default)s).')
     subparser.add_argument('--port',
                            type=int,
                            default=1883,
-                           help='Broker port (default: 1883).')
+                           help='Broker port (default: %(default)s).')
     subparser.add_argument('--client-id',
                            help='Client id (default: mqttools-<UUID[0..14]>).')
     subparser.add_argument('--keep-alive',
                            type=int,
                            default=0,
-                           help=('Keep alive time in seconds (default: 0). Give '
-                                 'as 0 to disable keep alive.'))
+                           help=('Keep alive time in seconds (default: '
+                                 '%(default)s). Give as 0 to disable keep '
+                                 'alive.'))
     subparser.add_argument('topic', help='Topic to subscribe for.')
     subparser.set_defaults(func=_do_subscribe)