rust-lang / rust-lang/rustfmt

Empty line after comment is removed

Open
#3,716 1 comment 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-comments A-whitespace I-poor-formatting
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

When there is an empty line after a comment in a struct declaration or struct literal, it is removed. This happened to me in a struct where fields are grouped logically, as in this example:

struct MyStruct {
    field1: String,
    field2: usize,
    field3: MyType,
    // This group ends here, and I want this comment to be attached to its end

    field4: f64,
    field5: f64,
    field6: f64,
}

Running rustfmt on the code above removes the empty line, destroying the logical grouping of the fields.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported rustfmt behavior with the Rust struct example in the issue, then trace how rustfmt handles comments and blank lines in struct declarations and literals. Done means the empty line after a comment is preserved while formatting, with coverage for both forms.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.