rust-lang / rust-lang/rustfmt

Rustfmt is … confused 😳 by `//` comment after `pub` and before `trait`

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

Nobody has claimed this yet.

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

Description

I tried formatting this code:

pub // should the following be private?
trait Asso<'ciativity> {}

Rustfmt left me with this gem:

pub trait Asso<'ciativity> // should the following be private?
trait Ass
{
}

👀

  • (note: @Noratrieb did not let me rename the trait 👉 👈)

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

Reproduce the formatting result using the Rust Playground link in the issue, then trace rustfmt's handling of a line comment between pub and trait. Done means formatting this input no longer produces the malformed output shown in the report; add or update a regression test if the relevant test location is found.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.