Auto-syncs stale docstrings and README when function signatures change. Detects documentation drift after refactors, parameter additions, or return type changes. Dry-run by default — proposes before writing.
87
100%
Does it follow best practices?
Impact
86%
1.59xAverage score across 17 eval scenarios
Passed
No known issues
A backend team added a new parameter to a documented Python function and wants to update the docs using --apply mode. The report must be shown first, and explicit confirmation must be requested before any write is performed.
Extract the following files, then set up the git repository:
=============== FILE: inputs/setup.sh =============== #!/usr/bin/env bash set -euo pipefail git init git config user.email "dev@example.com" git config user.name "Dev" mkdir -p src cat > src/formatter.py << 'PYEOF' def format_currency(amount: float, symbol: str = "$") -> str: """Format a monetary amount as a string.
Args:
amount: The numeric amount to format.
symbol: Currency symbol prefix.
Returns:
Formatted string like "$1,234.56".
"""
return f"{symbol}{amount:,.2f}"PYEOF git add -A && git commit -m "baseline" cat > src/formatter.py << 'PYEOF' def format_currency(amount: float, symbol: str = "$", locale: str = "en_US") -> str: """Format a monetary amount as a string.
Args:
amount: The numeric amount to format.
symbol: Currency symbol prefix.
Returns:
Formatted string like "$1,234.56".
"""
return f"{symbol}{amount:,.2f}"PYEOF
Sync the documentation in --apply mode and write the results to doc-sync-report.md, including the report and the explicit confirmation prompt shown before any write.
evals
scenario-1
scenario-2
scenario-3
scenario-4
scenario-5
scenario-6
scenario-7
scenario-8
scenario-9
scenario-10
scenario-11
scenario-12
scenario-13
scenario-14
scenario-15
scenario-16
scenario-17