Little fixes found during cnfvar-api-Review
[pyi2ncommon] / src / dial.py
index e34921a..30e930e 100644 (file)
@@ -79,8 +79,6 @@ __all__ = (
     "arnied_dial_hangup", "arnied_dial_doc", "arnied_dial_permanent", "dialout", "get_wan_address", "DIALOUT_MODE_PERMANENT", "DIALOUT_MODE_MANUAL", "DIALOUT_MODE_DEFAULT", "DIALOUT_MODE_BY_NAME"
 )
 
-TELL_CONND_BIN = "/usr/intranator/bin/tell-connd"
-
 DIALOUT_MODE_PERMANENT = 0
 DIALOUT_MODE_MANUAL = 1
 DIALOUT_MODE_DEFAULT = DIALOUT_MODE_PERMANENT
@@ -93,8 +91,12 @@ NEEDLE_MEMO = "  \[%s\] :(.*connected online fsm<online>.*)"
 NEEDLE_OFFLINE = re.compile("connection map:\nend of connection map")
 
 DIALTOOLS_HANGUP_BIN = "/usr/intranator/bin/hangup"
+
+#: binary for manual dialing (dial on command)
 DIALTOOLS_DOC_BIN = "/usr/intranator/bin/doc"
 DIALTOOLS_TIMEOUT = 10  # s
+
+#: client binary for talking to connd
 TELL_CONND_BIN = "/usr/intranator/bin/tell-connd"
 
 
@@ -133,7 +135,7 @@ def arnied_dial_hangup(block=False):
 
 def arnied_dial_doc(prid="P1", block=False):
     """
-    Bring provider up via arnied manual dial.
+    Bring provider up via arnied manual dial (dial on command).
 
     :param  prid:   Provider id, default *P1*. It is up to the caller to ensure
                     this is a valid provider id.