Added a little note to address #297

tomerfiliba · Dec 3, 2016 · c3ecdc5 · c3ecdc5
1 parent 11196dc
commit c3ecdc5
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/plumbum/commands/processes.py b/plumbum/commands/processes.py
@@ -177,7 +177,7 @@ def _shutdown_bg_threads():
 def run_proc(proc, retcode, timeout = None):
     """Waits for the given process to terminate, with the expected exit code
 
-    :param proc: a running Popen-like object
+    :param proc: a running Popen-like object, with all the expected methods.
 
     :param retcode: the expected return (exit) code of the process. It defaults to 0 (the
                     convention for success). If ``None``, the return code is ignored.