format_code_in_doc_comments adds trailing whitespace on the leading empty line
Open
Nobody has claimed this yet.
A-comments
C-bug
I-trailing-whitespace
only-with-option
UO-format_code_in_doc_comments
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Input (no trailing whitespaces anywhere):
/// Hi
///
/// ```text
///
/// rrr
///
/// xxx
/// ```
fn foo() {
}
rustfmt +nightly --config format_code_in_doc_comments=true
outputs:
/// Hi
///
/// ```text
///<WHITESPACE>
/// rrr
///
/// xxx
/// ```
fn foo() {}
Note whitespace is inserted only on the first empty line.
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
Start by reproducing the issue with rustfmt +nightly --config format_code_in_doc_comments=true using the Rust snippet in the report. Trace the format_code_in_doc_comments path and verify that the output no longer adds whitespace to the first empty line inside the documented code block.
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