Code in block doc comments are not formatted
Open
Nobody has claimed this yet.
A-comments
only-with-option
- Dominant language
- Rust
- Stars
- 7k
- Forks
- 1.1k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 24
Description
With format_code_in_doc_comments = true, rustfmt 1.6.0-nightly can format code in line doc comments, but code in block doc comments cannot be formatted.
/// ```rust
/// println!("hello"); // formatted
/// ```
/**
```rust
println!("hello"); // not formatted
```
*/
fn f() {}
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 provided Rust snippet and format_code_in_doc_comments = true, comparing line and block doc comments. Trace rustfmt's documentation-comment formatting entry point, then verify that the Rust code inside the block comment is formatted consistently with the line-comment example.
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
- 35/100