format_code_in_doc_comments insert extra line with trailing whitespaces if there there's a comment and a hash
Open
Nobody has claimed this yet.
A-comments
I-trailing-whitespace
only-with-option
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Input:
//! Test test
//!
//! ```
//! # fn main() {
//! println!("hello"); // Comment
//! # }
//! ```
mod arena;
rustfmt +nightly --config format_code_in_doc_comments=true
outputs:
//! Test test
//!
//! ```
//! # fn main() {
//! println!("hello"); // Comment
//!<5 SPACES>
//! # }
//! ```
mod arena;
rustfmt 1.7.0-nightly (ca663b06 2024-01-08)
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
Reproduce the issue with the Rust doc-comment input and the rustfmt +nightly --config format_code_in_doc_comments=true command shown in the report. Trace the formatter’s handling of a comment followed by a hash inside a documentation code block, then verify that formatting no longer inserts a blank line containing trailing spaces and add a regression test for the reported input.
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