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
{
"context": "Agent must detect @deprecated decorator as a caller-visible contract change and update docstring while flagging README for human review. Baseline models often ignore decorators or over-rewrite README migration docs.",
"type": "weighted_checklist",
"checklist": [
{
"name": "Deprecation documented in docstring",
"description": "The fetch_user docstring is updated to indicate the function is deprecated and suggests using get_user instead",
"max_score": 30
},
{
"name": "README flagged for review",
"description": "The report flags README.md mention of fetch_user as [NEEDS HUMAN REVIEW] and does NOT auto-rewrite it",
"max_score": 50
},
{
"name": "Unified report format used",
"description": "The output contains '## Doc Sync Report' as the top-level heading",
"max_score": 45
}
]
}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