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 monorepo has a package README at packages/auth/README.md (not the root README). A documented function verify_token in packages/auth/auth.py gained a new parameter. The root README.md does not mention this function. Only the package README mentions it in a code span.
The skill must find the package-level README mention and propose there (never auto-write markdown).
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 packages/auth
cat > packages/auth/auth.py << 'PYEOF' from future import annotations
def verify_token(token: str) -> bool: """Verify an authentication token.
Args:
token: The raw token string.
Returns:
True if the token is valid.
"""
return bool(token)PYEOF
cat > packages/auth/README.md << 'MDEOF'
Use verify_token(token) to validate tokens.
Do not auto-apply markdown edits. MDEOF
cat > README.md << 'MDEOF'
Root documentation. MDEOF
git add -A && git commit -m "baseline"
cat > packages/auth/auth.py << 'PYEOF' from future import annotations
def verify_token(token: str, expiry_seconds: int = 3600) -> bool: """Verify an authentication token.
Args:
token: The raw token string.
Returns:
True if the token is valid.
"""
_ = expiry_seconds
return bool(token)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