Update app.py

app.py

@@ -12,6 +12,19 @@ global parsed_input_data
 global original_outputs, yaml_outputs
 
 def process_survey(button_type, survey_submission_ID): 
+    """
+    Gets the data from the survey submission, then processes it with models to get output (data-filled) JSON Schemas. 
+    parse_survey_stack_data and parse_survey_stack_parameters complete the "back-end" data processing and can be found in a separate file
+
+    Args: 
+        button_type: (str) 'data' or (str) 'param' indicating whether processing the data survey or the parameter survey. When the parameter survey is processed, it sends the data for further processing.
+        survey_submission_ID: (str) Survey Submission ID (for retrieving survey)
+
+    Returns: 
+        (1) All front-end interactivity for hiding already used elements and showing new ones
+        (2) when button-type == 'data', the parsed input data
+        (3) when button-type == 'param', 3 JSONs representing the schemas for farm activity, interactions, and scientific trials
+    """
     if button_type == 'data':
         survey_id = "671fc52152e3225d7de349e6"
         
@@ -58,6 +71,15 @@ def process_survey(button_type, survey_submission_ID):
 
     
 def display_parameter_survey():
+    """
+    Display parameter survey based on the IDs necessary to render the survey
+
+    Args: 
+        None 
+
+    Returns: 
+        HTML of survey in an iframe which gradio renders automagically in the variable parameter_survey_output
+    """
     base_url = "https://app.surveystack.io/groups/"
     group_id = "5e95e368fbbf75000146a006"  # Group ID "Our-Sci"
     survey_id = "671fe2d352e3225d7de34afc" # survey id for parameter survey
@@ -74,6 +96,15 @@ def display_parameter_survey():
     return iframe_html
     
 def display_data_survey():
+    """
+    Display data survey based on the IDs necessary to render the survey
+
+    Args: 
+        None 
+
+    Returns: 
+        HTML of survey in an iframe which gradio renders automagically in the variable data_survey_output
+    """
     base_url = "https://app.surveystack.io/groups/"
     group_id = "5e95e368fbbf75000146a006"  # Group ID "Our-Sci"
     survey_id = "671fc52152e3225d7de349e6" # survey id for data survey
@@ -88,6 +119,21 @@ def display_data_survey():
     return iframe_html
     
 def update_toggle(toggle, farm_output_box, interactions_output_box, trials_output_box):
+    """
+    Used as function for toggle (button that you can slide left and right). 
+    Allows for data to be transformed between JSON and YAML forms, without losing either
+    Both are persisted as globals (not a great practice in general) but allows for swapping between for viewing
+    Toggle is not a part of base gradio and it was added additionally from here https://github.com/dwancin/gradio-toggle
+    
+    Args: 
+        toggle: the Toggle element 
+        farm_output_box: the text box designated for displaying the farm activity data JSON
+        interactions_output_box: the text box designated for displaying the interactions data JSON
+        trials_output_box: the text box designated for displaying the trials data JSON
+
+    Returns: 
+        3 YAML/JSON outputs displayed in the appropriate textboxes 
+    """
         global original_outputs, yaml_outputs
     
         if toggle and not yaml_outputs:
@@ -108,6 +154,7 @@ def update_toggle(toggle, farm_output_box, interactions_output_box, trials_outpu
             return original_outputs[0], original_outputs[1], original_outputs[2]
             
 with gr.Blocks() as app: 
+    # This is the main driver of the program that sets up the gradio front end pieces, as well as specific interactivity with buttons
     with gr.Row():
         data_survey_output = gr.HTML(value=display_data_survey())
 
@@ -145,5 +192,5 @@ with gr.Blocks() as app:
         outputs=[get_survey_back, parameter_survey_output, data_survey_output, data_submit_button, survey2_submission_ID, param_submit_button]
     )
     
-# Comment to rerun
+# This starts the program
 app.launch()