Skip to content

chore: fix clippy doc-comment warnings across the workspace - #269

Merged
maui1911 merged 1 commit into
mainfrom
chore/clippy-doc-warnings
Jun 12, 2026
Merged

chore: fix clippy doc-comment warnings across the workspace#269
maui1911 merged 1 commit into
mainfrom
chore/clippy-doc-warnings

Conversation

@maui1911

Copy link
Copy Markdown
Owner

Clears the long-standing doc-comment clippy debt (16 warnings under rust 1.95). Three categories, all cosmetic — no behavior changes:

  • doc_lazy_continuation — lines starting with + parse as Markdown list items, making the following lines unindented continuations. Rewrapped so + never starts a line (src/sidebar.rs, src/text_field.rs, terminal/src/colors.rs).
  • doc_overindented_list_items — visually-aligned bullet continuations trimmed to the 2-space Markdown standard (core/src/git.rs, core/src/theme/builtin.rs, src/command_palette.rs).
  • src/app.rs — a >-initial line parsed as a blockquote (reworded to "more than TOAST_VISIBLE_CAP"), and render_group's doc block had been orphaned above the titlebar drag handler by a later insertion — moved back onto its function.

cargo clippy --workspace --all-targets reports zero doc warnings; full test suite green (647 tests). The remaining non-doc clippy findings (too-many-arguments, enum size, etc.) are intentionally out of scope.

🤖 Generated with Claude Code

rust 1.95's clippy is stricter about Markdown inside doc comments.
Three categories, all cosmetic:

- doc_lazy_continuation: lines starting with '+' read as Markdown
  list items, turning the next lines into unindented continuations —
  rewrapped so '+' never starts a line (sidebar, text_field,
  terminal colors)
- doc_overindented_list_items: aligned continuations under bullet
  lists trimmed to the 2-space Markdown standard (git.rs, builtin
  theme, command palette)
- app.rs: a '>'-initial line parsed as a blockquote (reworded), and
  render_group's doc block had been orphaned above the titlebar
  handler by a later insertion — moved back to its function

No behavior changes; doc render now matches the intended text.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 11, 2026 21:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR cleans up Rust doc comments across the workspace to eliminate Clippy doc-comment warnings (notably doc_lazy_continuation and doc_overindented_list_items) without changing runtime behavior. It standardizes doc-comment wrapping/indentation so Markdown parsing is stable (no accidental lists/quotes), and reattaches one doc block to the correct function.

Changes:

  • Rewrapped doc lines so + no longer begins a doc-comment line (avoids doc_lazy_continuation).
  • Adjusted list-item continuation indentation to the 2-space Markdown standard (avoids doc_overindented_list_items).
  • Reworded a >-leading line and moved the render_group doc comment back onto its function.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
terminal/src/colors.rs Rewrapped doc text to avoid + starting a line in rustdoc Markdown.
src/text_field.rs Rewrapped module docs so + is not the first character on a doc line.
src/sidebar.rs Rewrapped/repunctuated doc text to avoid +-starting lines.
src/command_palette.rs Fixed list continuation indentation to satisfy Markdown/Clippy expectations.
src/app.rs Reworded a >-leading doc line and moved render_group docs onto the function.
core/src/theme/builtin.rs Trimmed overindented list continuation in test module docs.
core/src/git.rs Trimmed overindented list continuation in rustdoc list items.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@maui1911
maui1911 merged commit cc1c38e into main Jun 12, 2026
1 check passed
@maui1911
maui1911 deleted the chore/clippy-doc-warnings branch June 12, 2026 05:13
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