Fix cli syntax error tests - #159
Conversation
Greptile SummaryThis PR updates reference generation checks and the developer changelog. The main changes are:
|
| def read_manual_reference( | ||
| package: Any, | ||
| public_api: tuple[str, ...], | ||
| pages_by_symbol: Mapping[str, ReferencePage], |
There was a problem hiding this comment.
Manual Pages Skip Generation Check
When a manual reference page contains a public symbol name but its generated reference block is stale or incomplete, this path still returns the manual output successfully. The new package argument is not used to render or compare generated output, so out-of-sync manual pages can pass instead of raising the intended error.
Artifacts
Repro: generated script with temporary stale manual reference fixture and validation invocation
- Contains supporting evidence from the run (text/x-python; charset=utf-8).
Repro: runtime output showing stale manual page accepted with exit code 0
- Keeps the command output available without making the summary code-heavy.
|
|
||
|
|
||
| def read_manual_reference( | ||
| package: Any, |
There was a problem hiding this comment.
Manual Freshness Check Still Skips
When a manual reference page contains each public symbol name but its generated API block is stale, this path still returns the manual output successfully. package is now passed into read_manual_reference, but the function does not use it to render and compare the generated reference content, so out-of-sync manual pages can still pass validation.
Artifacts
Repro: focused Python harness with stale manual reference fixture
- Contains supporting evidence from the run (text/x-python; charset=utf-8).
Repro: harness output showing stale manual content was accepted
- Keeps the command output available without making the summary code-heavy.
|
Hi! This PR is ready for review whenever you have a chance. Thank you! |
|
Hi @kashvipeehu24 , I think there is some confusion, I don't see any valid issue for this PR. Issue #136 mentioned in description is a PR not issue. Can you please check what happened? |
| @@ -782,6 +782,7 @@ def render_reference( | |||
|
|
|||
|
|
|||
| def read_manual_reference( | |||
There was a problem hiding this comment.
When a manual reference page keeps all symbol headings but has stale generated details, this function still returns the manual output without comparing it to live generated content. The new package argument is unused, so render_reference skips the generated renderers and the reference check can pass with stale signatures, defaults, or field tables.
Artifacts
Repro: focused harness with stale manual reference content and monkeypatched live renderers
- Contains supporting evidence from the run (text/x-python; charset=utf-8).
Repro: command output showing stale manual content is accepted and generated renderers are skipped
- Keeps the command output available without making the summary code-heavy.
Summary
Contributor Checklist