rust-lang / rust-lang/rustfmt

`doc_comment_code_block_width ` doesn't work in inner comments

Open
#5,461 8 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

Code blocks in a //! doc comment don't seem to be formatted.

mod foo {
  //! ```
  //! horribly .formatted(code
  //! );
  //! ```
}

This is on nightly 2022-07-19 and on an older one as well.

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 provided nested //! example using doc_comment_code_block_width on the stated nightly or a current toolchain. Trace rustfmt's handling of inner documentation comments and code blocks; done means the code block is formatted according to the configured width, with coverage for this 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.