Repository navigation
docs: resolve all rustdoc warnings (clippy and compiler already clean) - #574
Merged
Merged
Conversation
Add c1.log, c2.log, chk.log, doc.log, and fmt.log as untracked files. Auto-committed-on: cuttlefish Co-authored-by: Medulla <medulla@tinyhumans.ai>
… spans Rustdoc cannot resolve intra-doc links that point at private items, so `[`Self::foo`]`-style references in public documentation were rewritten as plain code spans across the harness, orchestration, and registry crates. This keeps the docs building without broken-link warnings while preserving the same readable references. Auto-committed-on: cuttlefish Co-authored-by: Medulla <medulla@tinyhumans.ai>
Co-authored-by: Medulla <medulla@tinyhumans.ai>
Tiny Sweeper reviewVerdict: Incomplete · Priority: none Diagnostics and supporting detailsFull summaryPull request purpose (title): docs: resolve all rustdoc warnings (clippy and compiler already clean). This pull request is a follow-up to #573 titled "docs: resolve all rustdoc warnings (clippy and compiler already clean)". Its stated purpose is to clear the 23 rustdoc warnings found in an audit of main (21 `rustdoc::private_intra_doc_links` and 2 `rustdoc::redundant_explicit_links`) across harness, harness-tools, orchestration, and registry, without adding any `#[allow]` attributes. The diff is doc-comment only: intra-doc links to private items are converted to plain code spans and redundant explicit link targets are removed. No executable behaviour changes. The latest-push delta is unavailable. Unreviewed paths
Partial review reasons
Review snapshot
Completeness: Incomplete What changedTwenty-one files change with 23 additions and 23 deletions, all confined to documentation comments. Links such as `[`Store`](tinyagents_harness::store::Store)` in the scratchpad store module doc become a plain `[`Store`]` reference, and similar private-item links (`[`ledger`]`, `[`Self::record_tool_effect_started`]`, `[`select_tier`]`, `[`BLOCKED_AFTER_FAILURES`]`, `[`MAX_CANDIDATES`]`, `[`SchemaTransform`]`, `[`is_decorated_id`]`, and others) are converted to plain code spans. The redundant explicit target on `[`AgentProgress`]` in the orchestration run-progress-ledger module doc is dropped, and the `[module docs](self)` link in the retry failover module is replaced with plain text. Some links in the same doc comments remain untouched; the description lane notes these are pre-existing and outside the diff. Features
TestsNo supported feature-to-test mapping was produced. Test execution is not inferred. FindingsNo active actionable findings. Before merge
Agent review detailscritique
security
tests
commits
description
Evidence and run details
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Documentation reference corrections crates/tinyagents-harness-tools/src/{scratchpad/store.rs,state_block/mod.rs}, crates/tinyagents-harness/src/*, crates/tinyagents-orchestration/src/run_progress_ledger/mod.rs, crates/tinyagents-registry/src/pricing/mod.rs |
Documentation references were changed between Rustdoc links and code-formatted text, or requalified. The state-block ledger description was also reworded. No implementation behavior changed. |
Priority:
Estimated code review effort: 1 (Trivial) | ~5 minutes
Change: Other
Possibly related PRs
- tinyhumansai/tinyagents#549: Adds
run_progress_ledgerand its module documentation, which this PR updates. - tinyhumansai/tinyagents#573: Adds and exposes
run_progress_ledger, including the module documentation updated here.
Suggested reviewers: tinysweeper
Merge Risk: 
bfceb
-
No actionable merge-blocking risk is identified in this documentation-only change.
Pre-merge checks: 
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: resolving rustdoc warnings through documentation-only updates. Docstring Coverage Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 21 files. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
A rabbit checks each link with care
Then sets the code in backticks there
No runtime path is changed today
The docs now point a clearer way
I hop away, pleased with the repair
Comment @coderabbitai help to get the list of available commands.
![tinysweeper[bot]](https://avatars.githubusercontent.com/in/4526585?s=60&v=4){kind=small}
tinysweeper
Bot
added
the
priority: p3
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #573 (epic 7964). Audit of main for clippy findings and compiler warnings.
Before / after
cargo clippy --workspace --all-targets -- -D warningscargo clippy --workspace --all-targets --all-features -- -D warningscargo clippy --all-targets --all-features -- -D warningsin integration-proofs/run-ledger-mongodbcargo check --workspace --all-targets --lockedcargo build --workspace --all-targets(default, all-features)cargo fmt --all -- --checkcargo doc --workspace --no-deps --all-features(rustdoc warnings)The only findings were 23 rustdoc warnings (21
rustdoc::private_intra_doc_links, 2rustdoc::redundant_explicit_links) across harness, harness-tools, orchestration and registry. Fix: links to private items became plain code spans, redundant explicit targets removed. Doc comments only, no behaviour change; no#[allow]added.Verified
RUSTDOCFLAGS='-D warnings' cargo doc --workspace --no-deps --all-features: cleancargo test --workspace --all-features: 6159 passed, 0 failedAlso contains a commit adding and a commit removing stray lint logs (the history is not squashed); net diff is the 21 doc-comment files only.
Summary by CodeRabbit