rust-lang / rust-lang/rustfmt

rustfmt eats comment after `->` in return type

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

Nobody has claimed this yet.

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

Description

fn a() -> /* my super detailed comment on what this bool is */ bool {}

The comment is entirely eaten:

fn a() -> bool {}

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 running rustfmt on the minimal Rust snippet in the issue and compare its output with the input. Trace how rustfmt handles the comment after the return-type arrow; the issue is done when that comment is preserved in the formatted function.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.