rust-lang / rust-lang/rustfmt

Second comment line is not indented correctly

Open
#4,551 11 comments 0 reactions 1 assignee View on GitHub

@topecongiro is already working on this.

Since Nov 24, 2020.

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

Description

Input

fn main() {
    let x = 111;   /* First Comment line 1
                    * First Comment line 2 */

    let x = 222;   /* Second Comment line 1
		    * Second Comment line 2 */
}

Output

fn main() {
    let x = 111; /* First Comment line 1
                  * First Comment line 2 */

    let x = 222; /* Second Comment line 1
                    * Second Comment line 2 */
}

Expected output

fn main() {
    let x = 111; /* First Comment line 1
                  * First Comment line 2 */

    let x = 222; /* Second Comment line 1
                  * Second Comment line 2 */
}

The issue is the extra indentation of line 2 of the Second comment. The reason is that the * in that line is preceded by a tab and not by a space, and that light_rewrite_comment() is copying this preceding character from the original code.

If this is regarded as a bug that I can submit a PR with a fix from PR #4518 (simple fix - forcing the character preceding the * to be a space).

Meta

  • rustfmt version: rustfmt 2.0.0-rc.2-nightly (30bda450 2020-11-18)
  • From where did you install rustfmt?: self build

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.