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 Python function calculate_fee has conflicting documentation: its docstring describes one return type/units while the README describes another. The function's return type annotation changed from -> int to -> Decimal.
You must:
Extract the following file and 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/fees.py << 'PYEOF' from future import annotations
def calculate_fee(amount_cents: int, rate_percent: int = 5) -> int: """Calculate a fee for a transaction.
Args:
amount_cents: Amount in cents.
rate_percent: Fee rate as an integer percent.
Returns:
Fee in dollars as a float.
"""
return (amount_cents * rate_percent) // 100PYEOF
cat > README.md << 'MDEOF'
calculate_fee returns an integer fee in cents.
Do not auto-apply markdown edits. MDEOF
git add -A && git commit -m "baseline"
cat > src/fees.py << 'PYEOF' from future import annotations
from decimal import Decimal
def calculate_fee(amount_cents: int, rate_percent: int = 5) -> Decimal: """Calculate a fee for a transaction.
Args:
amount_cents: Amount in cents.
rate_percent: Fee rate as an integer percent.
Returns:
Fee in dollars as a float.
"""
return (Decimal(amount_cents) * Decimal(rate_percent)) / Decimal(100)PYEOF
Sync the documentation and write the results to doc-sync-report.md.
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