chore: fix clippy doc-comment warnings across the workspace - #269
Merged
Conversation
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>
There was a problem hiding this comment.
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 (avoidsdoc_lazy_continuation). - Adjusted list-item continuation indentation to the 2-space Markdown standard (avoids
doc_overindented_list_items). - Reworded a
>-leading line and moved therender_groupdoc 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.
This was referenced Jun 12, 2026
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.
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 thanTOAST_VISIBLE_CAP"), andrender_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-targetsreports 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