docs: add summary docstrings to all python scripts explaining their purpose

This commit is contained in:
Coco Sheng
2026-05-06 16:11:45 -04:00
parent 363cdef6e8
commit 59f1711543
12 changed files with 48 additions and 0 deletions
@@ -1,3 +1,7 @@
"""
Purpose: A utility to execute the agentic analysis loop on a single, specific issue by its ID.
Extremely useful for observing the tool-calling behavior, debugging prompts, or fixing edge cases without running the entire batch.
"""
import json
import urllib.request
import urllib.error
@@ -1,3 +1,7 @@
"""
Purpose: A focused script to generate or extract 'recommended_implementation' details for issues categorized as 'small' effort.
Helps create actionable code snippets for easy wins.
"""
import json
import urllib.request
import os
@@ -1,3 +1,7 @@
"""
Purpose: Injects recommended implementation snippets into the JSON data for specific, well-understood issues.
Allows maintainers to supplement AI analysis with exact code fixes.
"""
import json
BUGS_FILE = '../data/bugs.json'
@@ -1,3 +1,7 @@
"""
Purpose: Re-evaluates and modifies the effort level of specific issues based on hardcoded lists or heuristics.
Useful for bulk-updating effort levels (e.g., forcing certain complex bugs to 'large') after the initial AI pass.
"""
import json
import re
@@ -1,3 +1,7 @@
"""
Purpose: Updates the primary JSON data file with manually provided analysis.
Used to explicitly override or inject specific 'analysis', 'effort_level', and 'reasoning' values for known issues where AI analysis is insufficient.
"""
import json
BUGS_FILE = '../data/bugs.json'
@@ -1,3 +1,7 @@
"""
Purpose: Marks specific issues in the JSON dataset as 'validated = true'.
Used to track which AI analyses have been manually reviewed and approved by a human maintainer.
"""
import json
BUGS_FILE = '../data/bugs.json'
@@ -1,3 +1,7 @@
"""
Purpose: Runs heuristic post-analysis validation on the AI's effort estimations.
Checks for keywords (like 'Windows', 'WSL', 'PTY') in the issue body to ensure the AI didn't underestimate platform-specific or architecturally complex bugs as 'small'.
"""
import json
import re
import os