rust-lang / rust-lang/rustfmt

inconsistent behavior of `wrap_comments` (merges short lines in lists)

Open
#5,836 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

 /// a
 ///    b
 ///
 /// a
 /// b
 ///
 /// - a
 /// b
-/// - a
-///   b
+/// - a b
 fn main() {}

Why is only the last one wrapped? Is this expected behavior, or limitation of the implementation?

rustfmt 1.6.0-nightly (0e8e857b 2023-07-16)

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 provided Rust snippet with rustfmt 1.6.0-nightly (0e8e857b 2023-07-16), focusing on comment wrapping in ordinary paragraphs and list items. Trace the wrap_comments behavior to determine whether the difference is intentional or an implementation limitation; done means the behavior is clarified and, if unintended, covered by an appropriate regression test.

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
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.