rust-lang / rust-lang/rustfmt

[unstable option] format_code_in_doc_comments

Open
#3,348 19 comments 72 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

S-tracking-blocking-bugs unstable-option UO-format_code_in_doc_comments
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

Description

Tracking issue for unstable option: format_code_in_doc_comments

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 reviewing the tracking issue for the unstable format_code_in_doc_comments option and its discussion. The payload names no source files, tests, or entry points, so first identify the implementation and expected formatting behavior before work can be scoped. Done would require a decided design and completed support for the option.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.