Enforce rust-llm-tidy standards repo-wide and gate PRs on them - #148
Merged
Conversation
…ences, links, lints) Automated rust-llm-tidy output on the whole workspace with default settings, normalized with cargo fmt. Fixes links-op reference definitions that were appended outside doc comments by placing them back inside the doc comments. Remaining lint findings (DOC001/DOC002/DOC004/DOC006) still open.
…e DOC001/DOC004/DOC006 Fixes all 82 rust-llm-tidy lint findings across the workspace via parallel subagents; also settles remaining mod-declaration reorder convergence.
- reword redundant 'inlined inline' doc in entry.rs
- move doc comment above #[allow(dead_code)] in benches/common/mod.rs
- normalize # Arguments bullet style in bash impls and grep.rs to house
style ('- `x`: desc')
- keep cfg(test) test-module placement as rustfmt requires (rust-llm-tidy
reorder would move these 3 mods before their cfg(test) block; rustfmt
moves them after - the repo's formatter wins. rust-llm-tidy reports only
these 3 non-fatal REORDER records)
Add a Tidy workflow that tidies PR-changed .rs/.md files with the official rust-llm-tidy action (mode: apply) and, on a pull request, commits and pushes the fix commit back to the PR branch. No .rust-llm-tidy.yml config is required: the reorder op now agrees with rustfmt on cfg(test) test-module placement, so the default (no-config) run is clean across the whole tree and CI can gate on it.
Contributor
rust-llm-tidy: ✅ fixes appliedI tidied the files below and pushed commit 342428a. Changed files:
|
Contributor
rust-llm-tidy: ✅ all tidyAll files are tidy - no changes required. |
Contributor
rust-llm-tidy: ✅ all tidyAll files are tidy - no changes required. |
…gate pass Fix rustdoc unresolved-link warnings in builder.rs, core/context/mod.rs, serdesai/task.rs (field and crate-path doc links) for the cargo doc -D warnings CI gate. rust-llm-tidy's link op collapses inline [x](Self::x) links into reference-style [x] + [x]: Self::x and appends the defs at EOF outside any comment. rustdoc scopes reference defs to a single doc comment, and EOF defs are invalid Rust, so the tidy apply action would re-break builder.rs during the self-review gate. Inline crate:: links (core/serdesai) are tidy-stable; builder.rs field links use variant C: each doc comment using a label carries its own [label]: Self::<field> def, which tidy leaves alone and rustdoc accepts.
Automated by the rust-llm-tidy GitHub Action.
Contributor
rust-llm-tidy: ✅ all tidyAll files are tidy - no changes required. |
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
1 participant
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.
Enforce rust-llm-tidy standards repo-wide and gate PRs on them
ReloadedCode now conforms to the default rust-llm-tidy rule set, and CI auto-tidies every PR against it. The run resolves all 82 lint findings (DOC001, DOC002, DOC004, DOC006), so a no-config pass is clean across the whole workspace.
Applying the rust-llm-tidy default pass touched 171 files:
# Arguments,# Errors, and# Returnssections.cargo fmt.The last commits settle convergence between the tidy reorder rule and rustfmt on
cfg(test)test-module placement. That agreement is what lets CI gate on the default run with no.rust-llm-tidy.ymlconfig.CI gate. The new
tidy.ymlruns on PRs touchingsrc/**,**/*.md, or**/*.MD. It usesSewer56/rust-llm-tidy-action@v1in apply mode: checkout the PR branch head, tidy changed files in place, commit and push fixes back to the branch, then post a report comment.Risk. The only blast radius is the apply-mode workflow carrying
contents: writeon PRs; it force-applies style fixes to contributor branches automatically and can rewrite contributor commits.Verification. Not run. The workspace has no prebuilt
target/, so a full multi-crate check was out of scope here; each commit is cargo-fmt normalized and the final commit states the default run is clean.