Rustfmt should add enforce a single empty line before a doc comment
Open
Nobody has claimed this yet.
A-comments
A-whitespace
C-feature-request
P-low
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
Input
use std::cell::RefCell;
/// Main function
fn main() {
let a = RefCell::new(2);
dbg!(a);
}
Output
use std::cell::RefCell;
/// Main function
fn main() {
let a = RefCell::new(2);
dbg!(a);
}
Expected output
use std::cell::RefCell;
/// Main function
fn main() {
let a = RefCell::new(2);
dbg!(a);
}
Meta
- rustfmt version: rustfmt 1.4.30-stable
- From where did you install rustfmt?: rustup
CC @GuillaumeGomez
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 rustfmt 1.4.30-stable installed through rustup, using the Rust input shown in the report. Trace the formatting behavior for a doc comment and add coverage in the relevant rustfmt tests once its location is identified. Done means rustfmt inserts exactly one empty line before the doc comment without changing the other formatting.
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
- 38/100