rust-lang / rust-lang/rustfmt

Internal error when trying to format code with inline block comment

Open
#6,200 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When formatting this file
cargo +nightly fmt does not modify the file and reports this error:

error[internal]: left behind trailing whitespace
   --> <...>/riano/src/main.rs:353:353:58
    |
353 |                                     piano.sustain = true; 
    |                                                          ^
    |

warning: rustfmt has failed to format. See previous 1 errors.
$ cargo +nightly fmt --version
rustfmt 1.7.0-nightly (59e2c01 2024-06-17)

Removing the block comment on this line allows rustfmt to format the file again.

Thank you for maintaining this! 🧡

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 failure with cargo +nightly fmt using the linked src/main.rs and the inline block comment near line 350. Inspect the reported trailing-whitespace location around line 353; done means rustfmt formats the file successfully without the internal error while preserving the comment.

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
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.