Documentation and comment update

state.py

@@ -29,6 +29,20 @@ import utils
 verbosity = 4  # 0=None 1=Low 2=Medium 3=High 4=Debug
 
 def printV(message, level):
+    '''
+    Logging function to print based on verbosity level
+
+    ...
+
+    Parameters
+    ----------
+    message : str
+        Message to display
+    level : int
+        Target verbosity level of message; 0=None 1=Low 2=Medium 3=High 4=Debug
+    '''
+    # Read from global value above this function
+    global verbosity
     if verbosity >= level:
         print(message)
 
@@ -147,19 +161,37 @@ def build_all_csv_zip():
 # ---------------------------------------------------------------------------
 
 def addCategory():
+    '''
+    Create new category
+    '''
+    # Clean up input
     new = st.session_state.categoryInput.strip()
     if not new:
         return
+    # Notify user
     st.toast(f"Adding {new}")
+    # Update all relevant session_state variables
     st.session_state.categories.append(new)
     st.session_state.categorySelect.append([])
     st.session_state.pop(f"multiselect_{new}", None)
+    # Reset category input field
     st.session_state.categoryInput = ""
 
 
 def removeCategory(index):
+    '''
+    Remove category
+
+    Parameters
+    ----------
+    index : int
+        Index of category to be removed
+    '''
+    # Get name of category
     name = st.session_state.categories[index]
+    # Notify user
     st.toast(f"Removing {name}")
+    # Update all relevant session_state variables
     st.session_state.pop(f"multiselect_{name}", None)
     del st.session_state.categories[index]
     del st.session_state.categorySelect[index]
@@ -369,6 +401,9 @@ def on_grename_change(idx, token_display_map=None):
 # ---------------------------------------------------------------------------
 
 def updateMultiSelect():
+    '''
+    Updates multi-select field
+    '''
     fileName = st.session_state["select_currFile"]
     st.session_state.resetResult = True
     result = st.session_state.results.get(fileName)
@@ -610,11 +645,21 @@ def build_table_df(displayDF):
 # ---------------------------------------------------------------------------
 
 def analyze(inFileName):
-    """Compute and store all summary DataFrames for inFileName."""
+    """
+    Compute and store all summary DataFrames for inFileName.
+
+    Updates all session_state variables based on stored diarization results
+
+    Parameters
+    ----------
+    inFileName : str
+        Name of file to analyze
+    """
     try:
         printV(f"Start analyzing {inFileName}", 4)
         st.session_state.resetResult = False
 
+        # If file has not been processed by Sonogram, then end
         if not (
             inFileName in st.session_state.results
             and inFileName in st.session_state.summaries