@mechanai/deepreview 2.6.2 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -23,6 +23,22 @@ You will receive a path to a synthesis file. Read it.
|
|
|
23
23
|
2. For each finding, read ONLY the specific function or block referenced (use the Read tool with offset/limit to read ~50 lines around the referenced line — do NOT read entire files)
|
|
24
24
|
3. Write exact code changes for each fix
|
|
25
25
|
|
|
26
|
+
## Documentation Drift handling
|
|
27
|
+
|
|
28
|
+
If the synthesis contains a "Documentation Drift" section with a batched checklist, consolidate all those items into a **single** fix entry in the plan. Do not create separate fix entries for each documentation item. Use this format:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
### Fix [N]: Documentation Updates
|
|
32
|
+
**File(s):** [list all affected files]
|
|
33
|
+
**Priority:** suggestion
|
|
34
|
+
**Approach:** Batch update stale/verbose documentation
|
|
35
|
+
**Code changes:**
|
|
36
|
+
[Group changes by file. For each file, show the exact text replacement.]
|
|
37
|
+
**Verification:** Confirm updated docs match current code behavior
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Critical documentation findings (which appear individually in the "Critical Issues" section, not in "Documentation Drift") should still get their own fix entries.
|
|
41
|
+
|
|
26
42
|
## Quality rules
|
|
27
43
|
|
|
28
44
|
- **One clean solution per fix.** Do not include your reasoning process, rejected approaches, or self-corrections in the output. If you are unsure which approach is best, pick the simplest one and add a one-line "Alternative:" note.
|
|
@@ -25,8 +25,20 @@ If your prompt begins with a "Prior Findings" preamble, reviewers were instructe
|
|
|
25
25
|
|
|
26
26
|
1. Read all validated review files
|
|
27
27
|
2. Deduplicate: if multiple validators confirmed the same issue, merge into one entry and note agreement
|
|
28
|
-
3.
|
|
29
|
-
4.
|
|
28
|
+
3. Batch non-critical documentation findings into a single grouped checklist (see "Documentation finding batching" below)
|
|
29
|
+
4. Rank remaining findings by severity (critical first, then warning, then suggestion)
|
|
30
|
+
5. Within each severity level, rank by confidence (high before medium)
|
|
31
|
+
|
|
32
|
+
## Documentation finding batching
|
|
33
|
+
|
|
34
|
+
Documentation findings (stale comments, outdated counts, dead references, verbose docs) at **warning** or **suggestion** severity should be collapsed into a single "Documentation Drift" section rather than appearing as individual top-level entries in the severity sections.
|
|
35
|
+
|
|
36
|
+
Rules:
|
|
37
|
+
|
|
38
|
+
- **Critical** doc findings (false claims that would cause API misuse) remain as individual entries in "Critical Issues" — they are NOT batched
|
|
39
|
+
- **Warning** and **suggestion** doc findings are batched into a checklist in the dedicated "Documentation Drift" section
|
|
40
|
+
- Each checklist item gets one line: `- [ ] [what to fix] in \`path/to/file:line\``
|
|
41
|
+
- If there are zero non-critical doc findings, omit the "Documentation Drift" section entirely
|
|
30
42
|
|
|
31
43
|
## Output format
|
|
32
44
|
|
|
@@ -42,10 +54,16 @@ Write your synthesis to the output path provided. Use this structure:
|
|
|
42
54
|
[All critical severity items, deduplicated and ranked by confidence]
|
|
43
55
|
|
|
44
56
|
## Warnings (should fix)
|
|
45
|
-
[All warning severity items, deduplicated]
|
|
57
|
+
[All warning severity items, deduplicated — excludes documentation findings, which are batched below]
|
|
46
58
|
|
|
47
59
|
## Suggestions (nice to have)
|
|
48
|
-
[All suggestion items, grouped by theme]
|
|
60
|
+
[All suggestion items, grouped by theme — excludes documentation findings, which are batched below]
|
|
61
|
+
|
|
62
|
+
## Documentation Drift
|
|
63
|
+
The following doc/comment updates were identified (suggestion-level):
|
|
64
|
+
- [ ] [description of fix] in `path/to/file:line`
|
|
65
|
+
- [ ] [description of fix] in `path/to/file:line`
|
|
66
|
+
[Omit this section if there are no non-critical documentation findings]
|
|
49
67
|
|
|
50
68
|
## Points of Agreement
|
|
51
69
|
[Issues confirmed by multiple validators — these are highest confidence]
|