dbus_client: improve documentation
authorHelmut Grohne <helmut@subdivi.de>
Tue, 18 Jun 2013 21:42:47 +0000 (23:42 +0200)
committerHelmut Grohne <helmut@subdivi.de>
Tue, 18 Jun 2013 21:42:47 +0000 (23:42 +0200)
dbus_client.py

index 1bec799..7a5cbbb 100755 (executable)
@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 """
-A simpe client for an onoff device. If no parameters are given, the device
-is activated for 10 seconds. When a command is given, the device is activated,
-then the command is run. 10 seconds after the command finishes, the device is
+A simpe client for an onoff device. If no command is given, the device is
+temporarily activated. When a command is given, the device is activated, then
+the command is run. Some time after the command finishes, the device is
 released.
 """
 
@@ -30,7 +30,9 @@ def main():
     parser.add_argument("--duration", type=int, default=10,
                         help="how long to activate the device in seconds " +
                         "(default: %(default)d")
-    parser.add_argument("command", nargs=argparse.REMAINDER)
+    parser.add_argument("command", nargs=argparse.REMAINDER,
+                        help="a command to be executed with the device being" +
+                             "activated for the duration of the execution")
     args = parser.parse_args()
     DBusGMainLoop(set_as_default=True)
     proxy = onoff.dbusutils.get_dbus_proxy(args)