rustfmt eats comments in fn return type wrapped in parenthesis
Open
Nobody has claimed this yet.
A-comments
I-unexpectedly-removes-code
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
This code:
fn f() -> (/* is something */ bool) {}
Turns into this:
fn f() -> (bool) {}
Not too big of a deal as this isn't a tuple (due to the missing ,) and doesn't happen with tuples, but it should probably look for a comment here so it's retained after the programmer adds the , (and presumably other types, too)
Doesn't seem to happen in other places (like the type annotation for a local).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running rustfmt on the issue's minimal function example and compare the output with the input comment. Trace the formatting path for a parenthesized function return type, then add coverage for retaining the comment and verify that the existing tuple and local type-annotation cases remain unchanged.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100