Enhance docstrings in format_search_results_json and format_search_results functions for clarity on functionality and parameters

app.py

@@ -302,7 +302,13 @@ def find_synergistic_papers(abstract: str, limit=25) -> list[dict]:
 
 
 def format_search_results_json(abstract: str) -> str:
-    """Format search results as JSON for display"""
+    """Finds papers with Swanson-style bridges.
+
+    Args:
+        abstract (str): The abstract of the paper to find connections for, or a description of the research question.
+    Returns:
+        str: JSON string containing the list of papers with Swanson-style bridges.
+    """
     try:
         papers = find_synergistic_papers(abstract, limit=10)
         json_output = json.dumps(papers, indent=2)
@@ -313,9 +319,13 @@ def format_search_results_json(abstract: str) -> str:
 
 
 def format_search_results(abstract: str) -> tuple[pd.DataFrame, list[dict]]:
-    """Format search results as a DataFrame for display"""
-    # Find papers synergistic with the given abstract
-    # papers = embedding_model.find_synergistic_papers(abstract)
+    """Finds papers with Swanson-style bridges.
+
+    Args:
+        abstract (str): The abstract of the paper to find connections for, or a description of the research question.
+    Returns:
+        tuple: A tuple containing a DataFrame with the search results and a list of original paper data.
+    """
     try:
         papers = find_synergistic_papers(abstract)
     except ValueError as e: