wrap_comments=true can add a space to already properly formatted comments
Open
Nobody has claimed this yet.
A-comments
I-trailing-whitespace
only-with-option
S-duplicate
UO-wrap_comments
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
// rustfmt-wrap_comments: true
/// ```xxx```
///
/// xxx
pub struct X;
$ rustfmt --check --config=wrap_comments=true <tests/source/issue-xxx.rs
Diff in <stdin>:1:
// rustfmt-wrap_comments: true
/// ```xxx```
-///
+///
/// xxx
pub struct X;
error[internal]: left behind trailing whitespace
--> <stdin>:4:4:4
|
4 | ///
| ^
|
= note: set `error_on_unformatted = false` to suppress the warning against comments or string literals
warning: rustfmt has failed to format. See previous 1 errors.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the rustfmt command shown, using tests/source/issue-xxx.rs and wrap_comments=true. Start by tracing the comment-wrapping behavior for the blank documentation comment, then verify that rustfmt --check no longer reports trailing whitespace or changes an already formatted 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
- Mostly clear
- Newbie friendliness
- 45/100