`format_code_in_doc_comments` adds empty line between trailing comment and hidden code
Open
Nobody has claimed this yet.
A-comments
A-whitespace
C-bug
I-poor-formatting
UO-format_code_in_doc_comments
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
/// ```
/// println!("1"); // comment
/// # println!("2")
/// ```
becomes
/// ```
/// println!("1"); // comment
///
/// # println!("2")
/// ```
rustfmt 1.8.0-nightly (9748d87dc7 2025-07-21)
Parent: #3348
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 issue with the Rust documentation example shown in the report and trace the rustfmt path controlled by format_code_in_doc_comments. The fix is complete when formatting no longer inserts an empty documentation line between the trailing comment and the hidden code, while the hidden code remains unchanged.
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
- Clearly specified
- Newbie friendliness
- 45/100