doc for exec_get_output_streamed()

plesk · Oct 8, 2024 · bf490be · bf490be
1 parent 314fd94
commit bf490be
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/pleskdistup/common/src/util.py b/pleskdistup/common/src/util.py
@@ -33,6 +33,10 @@ def exec_get_output_streamed(
     process_stderr_line: typing.Optional[typing.Callable[[str], None]],
     **kwargs,
 ) -> int:
+    '''
+    Allows to get stdout/stderr by streaming line by line, by calling callbacks
+    and returns process exit code
+    '''
     kwargs["stdout"] = (subprocess.DEVNULL if process_stdout_line is None
                         else subprocess.PIPE)
     kwargs["stderr"] = (subprocess.DEVNULL if process_stderr_line is None