rust-lang / rust-lang/rustfmt

Leave whitespace for logically grouped comments alone

Open
#1,283 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is seems that rustfmt is identifies an ending | (or perhaps simply not ;) as a continued block and doesn't mess with the whitespace, but it will change the formatting of the last entry:

Before
fn reduced_example(scaler: usize) {
    let control = (1 << 16) |     // Clock enable
                  (scaler << 8) | // Set PSEL to based on period
                  (1 << 7)  |     // Flash calibration done (set to default)
                  (1 << 1)  |     // Disable after reset
                  (1 << 0);       // Enable
}
After
fn reduced_example(scaler: usize) {
    let control = (1 << 16) |     // Clock enable
                  (scaler << 8) | // Set PSEL to based on period
                  (1 << 7)  |     // Flash calibration done (set to default)
                  (1 << 1)  |     // Disable after reset
                  (1 << 0); // Enable
}

I believe this is a similar but distinct case from #1275

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

No source file or test is named. Start by reproducing the Before/After Rust example and trace rustfmt's handling of continued | expressions with comments; done means the final comment retains the surrounding alignment instead of being reformatted independently.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.