Skip to content

docs: fix rustdoc errors so cargo doc passes with -D warnings - #523

Open
hyperpolymath wants to merge 2 commits into
mainfrom
fix/cargo-doc-warnings-clean
Open

hyperpolymath wants to merge 2 commits into
mainfrom
fix/cargo-doc-warnings-clean

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

PR 1 of the rust-ci migration scoping: make cargo doc --no-deps --document-private-items --workspace pass with RUSTDOCFLAGS=-D warnings, the doc gate the estate reusable rust-ci.yml (proven-cicd-and-workflows@5b6024c) runs. Doc comments only; no code change.

Changes

  • exchange/lambdapi.rs: bare URL wrapped as an autolink.
  • coprocessor/physics.rs: [omega] / [lambda] prose no longer parsed as intra-doc links.
  • corpus/embed.rs: public doc no longer links to private NGRAM_WEIGHTS.
  • gnn/graph.rs: TypeInfo link now points at crate::types::TypeInfo.
  • provers/{cadical,kissat,minisat}.rs, provers/dreal.rs: Vec<i64> and <value> put in code spans (unclosed HTML tag errors).

Verification

  • cargo doc --locked --no-deps --document-private-items --workspace --keep-going with -D warnings: exit 0 (was 13 errors in the root crate).
  • Reusable's check.sh doc phase: pass. cargo fmt --check: pass.
  • Not re-run: full test/clippy (doc comments only; the earlier pre-change run passed).

RSR Quality Checklist

Required

  • Code is formatted
  • No new warnings
  • No secrets, credentials, or .env files included

Generated by Claude Code

Unclosed HTML tags (Vec<i64>, <value>), bare URL, intra-doc links to
bracketed prose and a private item. Doc comments only; no code change.
Prerequisite for adopting the estate rust-ci doc gate.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0136P7ZkqCNUotDR2GTtx8G3
@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Improved Markdown formatting and linking in technical documentation, including parameter notation, type references, and code examples.

Rust documentation changed across several modules. The edits update parameter notation, type formatting, and links. No implementation behaviour changed.

Changes: Rust documentation

Layer / File(s) Summary
Documentation notation and links
src/rust/coprocessor/physics.rs, src/rust/corpus/embed.rs, src/rust/exchange/lambdapi.rs, src/rust/gnn/graph.rs, src/rust/provers/cadical.rs, src/rust/provers/dreal.rs, src/rust/provers/kissat.rs, src/rust/provers/minisat.rs
Documentation examples now use revised parameter notation, inline code formatting, and link formatting.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: Minimal · up to da2e5

This PR only adjusts documentation comments so the rustdoc CI gate passes. It does not change runtime behavior, and no merge-blocking risk is apparent.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the change: rustdoc fixes so cargo doc passes with -D warnings. The diff is documentation-comment-only across the listed Rust files, which matches the title. The title is specific and …
Description check Passed The description fills the Summary, Changes, Verification, and the Required checklist items. It explains the purpose, lists each file change, and reports the cargo doc and fmt results. Some template se…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the change: rustdoc fixes so cargo doc passes with -D warnings. The diff is documentation-comment-only across the listed Rust files, which matches the title. The title is specific and conventional, so it passes.

Full details: Description check

Explanation

The description fills the Summary, Changes, Verification, and the Required checklist items. It explains the purpose, lists each file change, and reports the cargo doc and fmt results. Some template sections are absent: the Testing section is replaced by Verification, and the Screenshots section and the As Applicable checklist items are omitted. None of these are critical for a documentation-only change, so the description is mostly complete.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 45aa6064-7871-4d74-965e-b422130cb183
Commits

Reviewing files that changed from the base of the PR and between 75bfd46 and da2e55c.

Files selected for processing: 6

  • src/rust/corpus/embed.rs
  • src/rust/gnn/graph.rs
  • src/rust/provers/cadical.rs
  • src/rust/provers/dreal.rs
  • src/rust/provers/kissat.rs
  • src/rust/provers/minisat.rs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Recent review details

Context from checks skipped due to timeout: 16

  • GitHub Check: Rust Build — Real Chapel Library
  • GitHub Check: Rust Build with Chapel Feature
  • GitHub Check: CodeRabbit
  • GitHub Check: rust-ci / llvm-cov line coverage
  • GitHub Check: rust-ci / Cargo check + clippy + fmt
  • GitHub Check: MVP Smoke
  • GitHub Check: panic-attack assail
  • GitHub Check: Proof safety regressions
  • GitHub Check: PR (address)
  • GitHub Check: T1 / chuffed
  • GitHub Check: T1 / z3
  • GitHub Check: T1 / glpk
  • GitHub Check: T1 / minizinc
  • GitHub Check: Rebuild container image (independent runner)
  • GitHub Check: Build & verify container image
  • GitHub Check: semgrep-cloud-platform/scan
Additional context used

Code guidelines: 1

CLAUDE.md — auto-discovered
Path-based instructions: 1

Source excerpt: **Version + release history**: [`CHANGELOG.adoc`](CHANGELOG.adoc) (single source of truth; do not duplicate version strings elsewhere)

CodeRabbit inference engine (CLAUDE.md)

Files:

  • src/rust/corpus/embed.rs
  • src/rust/gnn/graph.rs
  • src/rust/provers/cadical.rs
  • src/rust/provers/dreal.rs
  • src/rust/provers/kissat.rs
  • src/rust/provers/minisat.rs

@linear-code
linear-code Bot marked this pull request as ready for review November 19, 2026 00:33
@sonarqubecloud

Copy link
Copy Markdown

This branch has not been deployed

No deployments
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.

3 participants