rust-lang / rust-lang/rustfmt

`/* comments */` are sometimes formatted away in function declarations

Open
#5,100 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

fn x<T: Clone>/* pls don't format me away */(x: T) {}
fn x/* pls don't format me away */<T: Clone>(x: T) {}
fn /* pls don't format me away */x<T: Clone>(x: T) {}

All of these examples are formatted to

fn x<T: Clone>(x: T) {}

but I expect the comment to stay.

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 issue by running rustfmt on the three Rust function declarations shown in the report. Inspect the formatter path for function declarations and its handling of comments around generic parameters; done means each /* pls don't format me away */ comment remains in the formatted output.

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.