rust-lang / rust-lang/rustfmt

Match arms with comments exceed max width

Open
#2,022 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

E.g. from librustc_mir/borrow_check.rs:

Output
fn append_lvalue_to_string(lvalue: &Lvalue, buf: &mut String) {
    match *lvalue {
        Lvalue::Projection(ref proj) => {
            let (prefix, suffix, index_operand) = match proj.elem {
                ProjectionElem::Downcast(..) => ("", format!(""), None), // (dont emit downcast info)
                ProjectionElem::Field(field, _ty) => ("", format!(".{}", field.index()), None), // FIXME: report name of field
            };
        }
    }
}
Expected
fn append_lvalue_to_string(lvalue: &Lvalue, buf: &mut String) {
    match *lvalue {
        Lvalue::Projection(ref proj) => {
            let (prefix, suffix, index_operand) = match proj.elem {
                ProjectionElem::Downcast(..) => {
                    ("", format!(""), None) // (dont emit downcast info)
                }
                ProjectionElem::Field(field, _ty) => {
                    ("", format!(".{}", field.index()), None) // FIXME: report name of field
                }
            };
        }
    }
}

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 with the Rust example in librustc_mir/borrow_check.rs and reproduce how rustfmt handles the match arms and their trailing comments. Trace the formatter behavior for comments and line width, then verify that the output matches the issue's expected multiline form without exceeding the configured maximum width.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.