-
Notifications
You must be signed in to change notification settings - Fork 20
Fix cli syntax error tests #159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
6e78b2c
654ea74
d6fa03e
4f94f12
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
||
|
|
@@ -782,6 +782,7 @@ def render_reference( | |
|
|
||
|
|
||
| def read_manual_reference( | ||
| package: Any, | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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. ArtifactsRepro: focused Python harness with stale manual reference fixture
Repro: harness output showing stale manual content was accepted
|
||
| public_api: tuple[str, ...], | ||
| pages_by_symbol: Mapping[str, ReferencePage], | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
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 ArtifactsRepro: generated script with temporary stale manual reference fixture and validation invocation
Repro: runtime output showing stale manual page accepted with exit code 0
|
||
| ) -> dict[Path, str] | None: | ||
|
|
@@ -803,6 +804,7 @@ def read_manual_reference( | |
| raise SystemExit( | ||
| f"Manual reference page {page.path} does not document {name!r}" | ||
| ) | ||
|
|
||
| return outputs | ||
|
|
||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
packageargument is unused, sorender_referenceskips 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
Repro: command output showing stale manual content is accepted and generated renderers are skipped