Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/en/dev/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ cut.

### Changed

- CLI: improved syntax error formatting to correctly display multiline source
text and caret positioning for indentation and end-of-line edge cases.

- CLI: split parser setup, command dispatch, local action handling, and remote
action handling into focused internal modules. Command syntax and behavior are
unchanged. ([#167](https://github.com/DevilsAutumn/quater/issues/167))
Expand Down
4 changes: 3 additions & 1 deletion scripts/generate_reference.py
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@ def render_reference(
public_api: tuple[str, ...],
pages_by_symbol: Mapping[str, ReferencePage],
) -> dict[Path, str]:
manual_outputs = read_manual_reference(public_api, pages_by_symbol)
manual_outputs = read_manual_reference(package, public_api, pages_by_symbol)
if manual_outputs is not None:
return manual_outputs

Expand All @@ -782,6 +782,7 @@ def render_reference(


def read_manual_reference(

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Manual Freshness Still Skips

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.

View artifacts

T-Rex Ran code and verified through T-Rex

Fix in Codex Fix in Claude Code

package: Any,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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.

View artifacts

T-Rex Ran code and verified through T-Rex

Fix in Codex Fix in Claude Code

public_api: tuple[str, ...],
pages_by_symbol: Mapping[str, ReferencePage],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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.

View artifacts

T-Rex Ran code and verified through T-Rex

Fix in Codex Fix in Claude Code

) -> dict[Path, str] | None:
Expand All @@ -803,6 +804,7 @@ def read_manual_reference(
raise SystemExit(
f"Manual reference page {page.path} does not document {name!r}"
)

return outputs


Expand Down