With wrap_comments = true, rustfmt removes significant empty doc lines
Open
Nobody has claimed this yet.
A-comments
I-unexpectedly-removes-code
only-with-option
UO-wrap_comments
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
axum contains the following pattern (here):
//! Text
//!
#![doc = include_str!("something.md")]
//!
//! More text
With wrap_comments = true, rustfmt currently removes the //! line before the #![doc] attribute, merging two paragraphs if something.md also starts with regular text (not a heading or sth. like that).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the axum pattern shown in the issue with rustfmt configured with wrap_comments = true, focusing on the //! line before the #![doc] attribute. Trace the comment-wrapping behavior and verify that the significant empty documentation line is preserved so the two paragraphs do not merge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100