Skip to content

fix(workflow-js): qualify rustdoc intra-doc links in driver.rs - #5777

Merged
Hmbown merged 1 commit into
mainfrom
fix/docs-ci-33351684365-20260831
Aug 31, 2026
Merged

fix(workflow-js): qualify rustdoc intra-doc links in driver.rs#5777
Hmbown merged 1 commit into
mainfrom
fix/docs-ci-33351684365-20260831

Conversation

@Hmbown

@Hmbown Hmbown commented Aug 31, 2026

Copy link
Copy Markdown
Owner

No-Issue: three-line rustdoc link qualification unblocking the Documentation CI job (failure seen in run 33351684365); pre-existing main defect, no behavior change.

Fixes the Documentation CI failure seen in run 33351684365: three unresolved intra-doc links (SCHEMA_REPAIR_MAX_ATTEMPTS, SCHEMA_RAW_CARRY_CHARS x2) in crates/workflow-js/src/driver.rs, qualified as crate:: paths.

Local proof: cargo doc -p codewhale-workflow-js --no-deps --locked generates cleanly.

The Documentation CI job fails on unresolved intra-doc links for
SCHEMA_REPAIR_MAX_ATTEMPTS and SCHEMA_RAW_CARRY_CHARS. Qualify them as
crate:: paths so rustdoc resolves them.

Unmasked by the full-CI dispatch in run 33351684365; pre-existing on main.

Signed-off-by: CodeWhale Bot <bot@codewhale.net>
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, add credits to your account and enable them for code reviews in your settings.

@claude

claude Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Claude finished @Hmbown's task in 1m 26s —— View job


Review of PR #5777

  • Gather context (diff, surrounding code)
  • Verify the doc-link fix is correct and complete
  • Check for other unqualified intra-doc links in the file
  • Post findings

Verdict: correct, minimal fix.

The diff qualifies three rustdoc intra-doc links in crates/workflow-js/src/driver.rs (lines 103, 199, 219) from [`SCHEMA_REPAIR_MAX_ATTEMPTS`]/[`SCHEMA_RAW_CARRY_CHARS`] to [`crate::SCHEMA_REPAIR_MAX_ATTEMPTS`]/[`crate::SCHEMA_RAW_CARRY_CHARS`].

I confirmed this resolves correctly:

  • Both constants are defined as pub const in crates/workflow-js/src/schema.rs (SCHEMA_REPAIR_MAX_ATTEMPTS, SCHEMA_RAW_CARRY_CHARS) and re-exported at the crate root via pub use schema::{SCHEMA_RAW_CARRY_CHARS, SCHEMA_RAW_PREVIEW_CHARS, SCHEMA_REPAIR_MAX_ATTEMPTS}; in lib.rs:74. Since driver.rs doesn't import these names directly, the unqualified [SCHEMA_...] links couldn't resolve from that module's scope — crate:: is the correct qualification.
  • I checked for other unqualified doc links in the file (TaskRequest, TaskCompletion, WorkflowDriver, BudgetSnapshot, ProgressEvent::TaskSchemaRepairAttempted, [`crate`], [`crate::testing::FakeDriver`]) — all of those are defined in driver.rs itself or already properly qualified, so no further changes are needed there.
  • Scope is exactly right: a 3-line link-path change, no unrelated edits, matches the stated root cause (Documentation CI job, run 33351684365).

I wasn't able to execute cargo doc -p codewhale-workflow-js --no-deps --locked myself in this sandbox (command execution was blocked), but the fix is verifiable by static inspection of the module paths as above, and the PR author's local proof output is consistent with that analysis.

No correctness, provider/route-safety, reuse, test-coverage, or security concerns — this is a pure doc-path fix with no behavioral change.

Branch: fix/docs-ci-33351684365-20260831

@codewhale-agent codewhale-agent Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Codewhale review

The PR updates three intra-doc links in driver.rs to use crate:: qualified paths, which should resolve the rustdoc failures for SCHEMA_REPAIR_MAX_ATTEMPTS and SCHEMA_RAW_CARRY_CHARS.

Assessment

Looks correct. The change is minimal, focused, and aligns with the Documentation CI failure. No additional tests are necessary for doc-link changes.


Advisory review by Codewhale (codewhale review --pr 5777 --post, head a9c228325be20fc709076d0045a3ca879d22eae2). Line-specific findings are also posted as inline review comments; mechanical fixes arrive as committable suggestions you can apply from the Files tab. CODEOWNERS approval still governs merge.

@Hmbown
Hmbown merged commit 2c6d340 into main Aug 31, 2026
30 of 31 checks passed
@Hmbown
Hmbown deleted the fix/docs-ci-33351684365-20260831 branch August 31, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant