rust-lang / rust-lang/rustfmt

Commented out `macro_rules` arm gets moved after previous arm

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

Nobody has claimed this yet.

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

Description

macro_rules! val {
    ($name:ident) => {
        stringify!($name)
    };
    // ($name:ident $value:literal) => {
    //     $value
    // };
}

gets formatted as

macro_rules! val {
    ($name:ident) => {
        stringify!($name)
    }; // ($name:ident $value:literal) => {
       //     $value
       // };
}

If wrap_comments = true is enabled it gets turned into a block comment which was quite a surprise

macro_rules! val {
    ($name:ident) => {
        stringify!($name)
    }; /* ($name:ident $value:literal) => {
        *     $value
        * }; */
}

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 reproducing the formatting change from the issue, with and without wrap_comments enabled, then trace the macro_rules comment-handling path. Add a regression test covering the commented-out arm and verify that formatting preserves its position and comment style.

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.