adding docstring to subprocess log fx

PermafrostDiscoveryGateway · Apr 15, 2023 · a00fb0d · a00fb0d · iannesbitt · Apr 16, 2023
1 parent b8c98a4
commit a00fb0d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/pdgpoints/lastools_iface.py b/pdgpoints/lastools_iface.py
@@ -8,6 +8,12 @@
 from . import utils
 
 def log_subprocess_output(pipe, verbose=False):
+    '''
+    Log the output from a lastools subprocess.
+
+    :param subprocess.PIPE pipe: The pipe to listen to
+    :param bool verbose: Whether to log more messages 
+    '''
     L.propagate = verbose
     try:
         for line in iter(pipe.readline, b''): # b'\n'-separated lines