Skip to content

Commit fdbef62

Browse files
committed
aexpect: Refine run_tail and run_bg docsrings
the first line should cover the main differences, let's add them there. Signed-off-by: Lukáš Doktor <ldoktor@redhat.com>
1 parent 815334c commit fdbef62

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

aexpect/client.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1716,7 +1716,8 @@ def run_tail(
17161716
encoding=None,
17171717
):
17181718
"""
1719-
Run a subprocess in the background and collect its output and exit status.
1719+
Run a command then await for it to finish up to timeout and return the
1720+
Tail object (alive or dead, allows reading output, no stdin interaction).
17201721
17211722
Run command as a subprocess. Call output_func with each line of output
17221723
from the subprocess (prefixed by output_prefix). Call termination_func
@@ -1769,7 +1770,8 @@ def run_bg(
17691770
encoding=None,
17701771
):
17711772
"""
1772-
Run a subprocess in the background and collect its output and exit status.
1773+
Run a command then await for it to finish up to timeout and return the
1774+
Expect object (alive or dead, allows interaction).
17731775
17741776
Run command as a subprocess. Call output_func with each line of output
17751777
from the subprocess (prefixed by output_prefix). Call termination_func

0 commit comments

Comments
 (0)