Skip to content

fix doc indentation check#1166

Merged
tomtau merged 3 commits into
masterfrom
fix-doc
Apr 18, 2026
Merged

fix doc indentation check#1166
tomtau merged 3 commits into
masterfrom
fix-doc

Conversation

@tomtau
Copy link
Copy Markdown
Contributor

@tomtau tomtau commented Apr 18, 2026

Summary by CodeRabbit

  • Chores
    • Updated crate-level lint configuration to suppress specific documentation indentation warnings.
    • Cleaned up benchmark iterator construction for clearer, fixed-length repetition in performance tests.

Note: Internal maintenance only; no functional or behavioral changes visible to end users.

@tomtau tomtau requested a review from a team as a code owner April 18, 2026 07:53
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9cfe61c5-90d3-4e00-9d53-1c10b37e3680

📥 Commits

Reviewing files that changed from the base of the PR and between 998188f and 5db4c8b.

📒 Files selected for processing (1)
  • pest/benches/stack.rs
✅ Files skipped from review due to trivial changes (1)
  • pest/benches/stack.rs

📝 Walkthrough

Walkthrough

Converted two crates' Clippy lint suppression to crate-level inner attributes and replaced repeat(...).take(n) with repeat_n(..., n) in a benchmark file; no public APIs or control flow changes.

Changes

Cohort / File(s) Summary
Pest crate attribute change
pest/src/lib.rs
Replaced #[allow(clippy::doc_overindented_list_items)] with inner #![allow(clippy::doc_overindented_list_items)], changing scope to crate-level.
Derive crate attribute addition
derive/src/lib.rs
Added #![allow(clippy::doc_overindented_list_items)] as a crate-level inner attribute to suppress the Clippy lint across the crate.
Benchmark iterator change
pest/benches/stack.rs
Replaced core::iter::repeat(...).take(times) with core::iter::repeat_n(..., times) for medium and large inputs in the benchmark helper. No logic or benchmarks altered otherwise.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • NoahTheDuke

Poem

🐰 I nudged a lint and smoothed a test,
Crates breathe easier, docs now rest.
Repeats made tidy, attributes set right,
I hop away happy into the night. 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix doc indentation check' accurately describes the main changes: adding and adjusting crate-level lint suppressions for the clippy::doc_overindented_list_items check across multiple files.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-doc

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.

@tomtau tomtau enabled auto-merge (squash) April 18, 2026 07:54
@tomtau tomtau merged commit d1a5bef into master Apr 18, 2026
10 checks passed
@tomtau tomtau deleted the fix-doc branch April 18, 2026 08:06
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