Skip to content

fix(fbuild-deploy): repair broken intra-doc links and fmt drift#201

Merged
zackees merged 1 commit intomainfrom
fix/ci-docs-and-fmt
Apr 24, 2026
Merged

fix(fbuild-deploy): repair broken intra-doc links and fmt drift#201
zackees merged 1 commit intomainfrom
fix/ci-docs-and-fmt

Conversation

@zackees
Copy link
Copy Markdown
Member

@zackees zackees commented Apr 24, 2026

Summary

Fixes two CI jobs that failed at commit 2aa2e34 (Upgrade GitHub Actions to Node 24):

Documentation

soldr cargo doc --workspace --no-deps with RUSTDOCFLAGS=-D warnings failed inside fbuild-deploy with four rustdoc::broken-intra-doc-links errors, all in the module-level //! doc header of crates/fbuild-deploy/src/esp32_native.rs:

error: unresolved link to `super::esp32::Esp32Deployer`
  = note: no item named `super` in scope
  = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`

error: unresolved link to `VerifyOutcome`
  = note: no item named `VerifyOutcome` in scope

error: unresolved link to `super::esp32::Esp32Deployer::with_native_verify`
  = note: no item named `super` in scope

error: unresolved link to `super::esp32::Esp32Deployer::with_native_write`
  = note: no item named `super` in scope

error: could not document `fbuild-deploy`

Under rustc 1.94.1, rustdoc does not resolve super:: from inner doc comments (//!) at the top of a module file, and VerifyOutcome is not in scope at the module-doc resolution site (the use crate::esp32::{..., VerifyOutcome} lives further down in the file body). Fixed by switching to unambiguous crate::esp32::... paths for all four links.

Formatting

cargo fmt --all -- --check complained about one block in crates/fbuild-deploy/src/esp32.rs:1245 (the native_write_or_fallback early-return around try_deploy_native). Applied cargo fmt. No other files touched.

Test plan

  • cargo doc --workspace --no-deps locally with RUSTDOCFLAGS=-D warnings (rustc 1.94.1) — passes
  • cargo fmt --all -- --check locally — passes
  • CI Documentation job — green on this PR
  • CI Formatting job — green on this PR

Diff: 2 files, 8 insertions, 9 deletions. No behavior change, docs-only + whitespace.

- esp32_native.rs module-level `//!` docs use `crate::esp32::...`
  instead of `super::esp32::...`. Rustdoc does not resolve `super`
  from inner doc comments at the module file level under rustc 1.94.1,
  which broke `cargo doc --workspace --no-deps` with
  `RUSTDOCFLAGS=-D warnings`. Also fully qualify `VerifyOutcome` as
  `crate::esp32::VerifyOutcome` since it is not in scope at the
  module-doc resolution site.
- esp32.rs: apply `cargo fmt` — the native-write early-return block
  had drifted out of the canonical layout.

Fixes CI runs 24900888165 (Documentation) and 24900888192 (Formatting).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

Warning

Rate limit exceeded

@zackees has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 36 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 53 minutes and 36 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 62124a63-47ba-4fa3-b707-a1ae3f14fe51

📥 Commits

Reviewing files that changed from the base of the PR and between 2aa2e34 and f3b59dc.

📒 Files selected for processing (2)
  • crates/fbuild-deploy/src/esp32.rs
  • crates/fbuild-deploy/src/esp32_native.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/ci-docs-and-fmt

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zackees zackees merged commit cfb4661 into main Apr 24, 2026
77 checks passed
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