rust-lang / rust-lang/rustfmt

Block comment removed from function signature when using unit

Open
#6,667 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs-triage
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

When I write a function like one of the following

fn foo() -> (/* some comment */) {}
fn bar(x: (/* some comment */)) {}
fn baz() -> Result<(/* some comment */), ()> {}

The comment inside the unit in the return/parameter type gets removed:

fn foo() -> () {}
fn bar(x: ()) {}
fn baz() -> Result<(), ()> {}

This does not happen inside of the function body itself:

fn qux() {
    (/* comment */) // this is fine
}

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 three function-signature examples and compare them with the function-body example using rustfmt. Locate the formatting path for comments inside unit types, add regression coverage for the affected signatures, and verify that the comments are preserved without changing the existing body behavior.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.