rust-lang / rust-lang/rustfmt

trait bounds with comments are not formatted

Open
#2,055 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This compiles file:

pub trait A {}
pub trait B {}
pub trait C {}

pub trait Foo:
// A and C
A + C
// and B
    + B
{}

but rustfmt formats it into this:

pub trait Foo: A + C + B // A and C
A
    + C
// and B
    + B {
}

try this live (just click on Format in the playground)

which fails to compile with:

   Compiling playground v0.0.1 (file:///playground)
error: expected one of `(`, `+`, `::`, `<`, `where`, or `{`, found `A`
 --> src/main.rs:6:1
  |
5 | trait Foo: A + C + B // A and C:
  |                     - expected one of `(`, `+`, `::`, `<`, `where`, or `{` here
6 | A + C
  | ^ unexpected token

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 with the Rust reproducer in the issue and run it through rustfmt, or use the linked Rust Playground example. Compare the formatted output with the compiler error and trace the rustfmt path responsible for trait bounds and comments. Done means formatting preserves the comments without producing code that fails to compile.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.