Update pyrpipe_engine.py

urmi-21 · Jun 29, 2020 · cdd0d26 · cdd0d26
1 parent d98b761
commit cdd0d26
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/pyrpipe/pyrpipe_engine.py b/pyrpipe/pyrpipe_engine.py
@@ -240,6 +240,10 @@ def getReturnStatus(cmd):
 #prints stdout in real time. optimal for huge stdout and no stderr
 def execute_commandRealtime(cmd):
     """Execute shell command and print stdout in realtime.
+    
+    Example:
+    for output in pe.execute_commandRealtime(['ping','-c','4','google.com']):
+        print (output)
     """
     popen = subprocess.Popen(cmd, stdout=subprocess.PIPE, universal_newlines=True)