add documentation

czbiohub-sf · Sep 5, 2023 · ccfe2db · ccfe2db
1 parent 5d20110
commit ccfe2db
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/copylot/__init__.py b/copylot/__init__.py
@@ -5,14 +5,24 @@
 
 import logging
 
-def enable_debug_logging(log_filepath = 'copylot_debug_log.txt'):
+
+def enable_debug_logging(log_filepath: str = 'copylot_debug_log.txt'):
+    """
+    Enable debug logging to a text file
+
+    Parameters
+    ----------
+    log_filepath : str
+        Path to log file, by default 'copylot_debug_log.txt'
+    """
     # create file handler which logs debug messages
     fh = logging.FileHandler(log_filepath)
     fh.setLevel(logging.DEBUG)
     fh.setFormatter(formatter)
 
     logger.addHandler(fh)
 
+
 logger = logging.getLogger('copylot')
 logger.setLevel(logging.DEBUG)