Merge pull request #206 from pathsim/fix/param-description-regex

Fix param description regex to handle indented docstrings

Author: milanofthe

scripts/extract-blocks.py

@@ -268,7 +268,8 @@ def extract_param_description(docstring: str, param_name: str) -> str:
 
     # Look for parameter in docstring (RST format)
     # Pattern: param_name : type\n    description
-    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\w|\n\n|$)"
+    # Stop at next param (indented or not), blank line, or end
+    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\s*\w+\s*:|\n\n|$)"
     match = re.search(pattern, docstring, re.DOTALL)
     if match:
         desc = match.group(1).strip()

scripts/extract-events.py

@@ -148,7 +148,8 @@ def extract_param_description(docstring: str, param_name: str) -> str:
     if not docstring:
         return ""
 
-    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\w|\n\n|$)"
+    # Stop at next param (indented or not), blank line, or end
+    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\s*\w+\s*:|\n\n|$)"
     match = re.search(pattern, docstring, re.DOTALL)
     if match:
         desc = match.group(1).strip()

scripts/pathsim_extractor.py

@@ -75,7 +75,8 @@ def extract_param_description(docstring: str, param_name: str) -> str:
     if not docstring:
         return ""
 
-    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\w|\n\n|$)"
+    # Stop at next param (indented or not), blank line, or end
+    pattern = rf"{param_name}\s*:\s*[^\n]*\n\s+(.+?)(?=\n\s*\w+\s*:|\n\n|$)"
     match = re.search(pattern, docstring, re.DOTALL)
     if match:
         desc = match.group(1).strip()