Skip to content

docs: unbreak rustdoc CI (escape angle-bracket placeholders)#503

Draft
EffortlessSteven wants to merge 1 commit into
mainfrom
claude/review-merge-prs-QuLEs
Draft

docs: unbreak rustdoc CI (escape angle-bracket placeholders)#503
EffortlessSteven wants to merge 1 commit into
mainfrom
claude/review-merge-prs-QuLEs

Conversation

@EffortlessSteven

Copy link
Copy Markdown
Member

Summary

Three doc comments were using <lane>, <path> and [options] unescaped, causing the strict-rustdoc CI gate (.github/workflows/docs.yml, RUSTDOCFLAGS="-D warnings") to fail with invalid-html-tags and broken-intra-doc-links errors. The failures were latent on main since 2026-05-15 because the workflow only triggers on crates/**/*.rs, Cargo.{toml,lock} and the workflow file itself — any push that doesn't touch a Rust file silently leaves docs red.

Files touched:

  • crates/cli/src/commands/mod.rs — wrap <lane>/lane-init.json in backticks
  • crates/tools/src/bin/validate_adr.rs — move usage / options into a fenced text block
  • crates/tools/src/bin/generate_docs_index.rs — same treatment

No behavior change; documentation only.

Verification

RUSTDOCFLAGS="-D warnings" cargo doc --all-features --workspace \
  --no-deps --locked --exclude racing-wheel-ui
# -> Finished, no warnings/errors

cargo clippy -p wheelctl -p openracing-tools --all-targets --all-features
# -> clean

cargo fmt --all -- --check
# -> clean

Safety

Documentation-only change. No RT path, IPC, hardware, or signature code touched.


Generated by Claude Code

`<lane>`, `<path>` and `[options]` in doc comments were being parsed by
rustdoc as HTML tags and intra-doc links, failing the strict
`-D warnings` gate in `.github/workflows/docs.yml`. Wrap them in
backticks / code blocks so they render verbatim.
@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@coderabbitai

coderabbitai Bot commented May 16, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

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

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 26029ee7-18db-4b97-b908-1f74cb06e6f7

📥 Commits

Reviewing files that changed from the base of the PR and between 10b7f8c and cb08f01.

📒 Files selected for processing (3)
  • crates/cli/src/commands/mod.rs
  • crates/tools/src/bin/generate_docs_index.rs
  • crates/tools/src/bin/validate_adr.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/review-merge-prs-QuLEs

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.

@github-actions

Copy link
Copy Markdown

Compatibility Layer Usage Report

Current usage count: 193
Baseline usage count: 193
ℹ️ Usage unchanged

📈 Usage Trend (Last 30 Days)

  • Peak usage: 193
  • Current trend: insufficient_data (0%)
  • Projected removal: unknown

Usage Details

  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/compat_impl.rs:69 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/hid/linux.rs:1253 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/hid/linux.rs:1282 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/hid/mod.rs:230 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/protocol.rs:290 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/protocol.rs:742 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/engine/src/protocol.rs:749 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/schemas/src/service_example.rs:189 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/schemas/src/service_example.rs:218 - temp_c
  • /home/runner/work/OpenRacing/OpenRacing/crates/schemas/src/integration_test.rs:79 - temp_c

... and 183 more occurrences

Migration Guide

To migrate these usages, replace:

  • .temp_c().temperature_c
  • .faults().fault_flags
  • .wheel_angle_mdeg().wheel_angle_deg
  • .wheel_speed_mrad_s().wheel_speed_rad_s

See Migration Patterns for detailed examples.

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.

2 participants