akshay-babbar/doc-sync
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
Evaluation results
100%
34%Scenario: Rust new pub fn added with zero prior documentation
Report missing documentation coverage for new Rust public functions without creating any new docstrings or README entries.
Missing coverage reported
100%
100%
No documentation created
100%
100%
Unified report format used
0%
100%
83%
20%Scenario: Go exported function renamed; must flag, not rewrite docs
Flag renamed exported Go functions for human review without deleting old README references or inventing new documentation.
Rename flagged for review
80%
100%
README not auto-rewritten
100%
54%
Unified report format used
0%
100%
100%
44%Scenario: Python deprecated decorator added; must surface deprecation and flag README
Detect newly added deprecation on a documented Python function and surface it as a docstring update plus a human-review flag for README references.
Deprecation documented in docstring
100%
100%
README flagged for review
80%
100%
Unified report format used
0%
100%
100%
55%Scenario: Markdown proposal cascades across multiple files for one documented symbol
Docstring updated
100%
100%
All markdown mentions proposed
72%
100%
Numbered entries present
0%
100%
Unified report format used
22%
100%
100%
74%Show Full Report Before Apply Confirmation
Apply mode declared
0%
100%
Report shown before confirmation
55%
100%
Numbered entries available for confirmation
0%
100%
Change identified
100%
100%
100%
30%Catch Stale Docstring After Validation Logic Change
Stale docstring updated
100%
100%
Body-only drift detected
100%
100%
Not stopped at script exit
100%
100%
Unified report format
0%
100%
48%
-14%Scenario: Docstring and README contradict; return type changes
Docstring return type updated
100%
0%
README update proposed not auto-written
100%
100%
Conflict or inconsistency surfaced
55%
66%
Unified report format
0%
0%
100%
39%Skip Already-Current Docstrings During Apply Mode
No duplicate parameter entry
100%
100%
Already current reported
100%
100%
Unified report format
0%
100%
Apply mode declared
44%
100%
96%
53%Update Java Service Documentation After Adding Retry Parameter
New @param added
100%
93%
Javadoc format used
100%
100%
Existing @param lines untouched
100%
88%
README update proposed
0%
100%
README not auto-written
0%
100%
Unified report format
0%
100%
100%
27%Scenario: Large noisy diff; only one relevant doc change
parse_config docstring updated
100%
100%
No false positives on other files
100%
100%
Noisy diff navigated correctly
100%
100%
Unified report format
0%
100%
17%
-61%Update Parameter Documentation Without Touching Rich Docstring Content
Timeout param documented
66%
0%
Examples section preserved
100%
0%
Notes section preserved
100%
0%
See Also section preserved
100%
0%
Existing args untouched
100%
0%
Unified report format
0%
100%
54%
-9%Scenario: Monorepo package README (not root) contains the mention
verify_token docstring updated
0%
0%
Package README proposal made
100%
100%
Root README not touched
100%
100%
Unified report format
33%
0%
92%
54%Reconcile Documentation After Module Restructuring
Human review flagged
0%
50%
Move context reported
100%
100%
README not auto-updated
0%
100%
Documentation not deleted
100%
100%
Unified report format
0%
100%
93%
55%Add Export to API Reference Documentation
README mention proposed
0%
57%
README not auto-written
0%
100%
New symbol with docstring handled
100%
100%
Unified report format
0%
100%
Existing function untouched
100%
100%
86%
-9%Scenario: Protected file mention exists alongside a valid README proposal
Docstring updated
100%
0%
README proposal made
100%
100%
README not auto-written
100%
100%
CHANGELOG ignored completely
100%
100%
Unified report format
77%
100%
100%
88%Sync Docs After Parameter Addition to Core Function
Go doc comment updated
100%
100%
CHANGELOG not modified
0%
100%
ADR not modified
0%
100%
CHANGELOG absent from report proposals
0%
100%
Unified report format
0%
100%
100%
70%Sync Documentation for Renamed Return Type in Analytics Module
JSDoc return updated
100%
100%
README table proposal made
0%
100%
README not auto-written
0%
100%
Table mention not skipped
100%
100%
Unified report format
0%
100%
- Evaluated
- Agent
- Claude Code
- Model
- Claude Sonnet 4.6
Table of Contents