summaryrefslogtreecommitdiff
path: root/alot
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-01-07 12:49:10 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-01-07 12:49:10 +0000
commitf64098c85c2a6d75318ebdf4e9f3acfd42be3ae1 (patch)
treea8d465f73b52ddbe7641c90613f894e4bbbf5861 /alot
parent211f2a28ede8ed200cf373c5e8b11e12760ddc35 (diff)
docs: added warning for call_cmd helper
Diffstat (limited to 'alot')
-rw-r--r--alot/helper.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/alot/helper.py b/alot/helper.py
index 19976a4c..e2c85f05 100644
--- a/alot/helper.py
+++ b/alot/helper.py
@@ -214,7 +214,12 @@ def pretty_datetime(d):
def call_cmd(cmdlist, stdin=None):
"""
- get a shell commands output, error message and return value
+ get a shell commands output, error message and return value and immediately
+ return.
+
+ .. warning::
+
+ This returns with the first screen content for interctive commands.
:param cmdlist: shellcommand to call, already splitted into a list accepted
by :meth:`subprocess.Popen`