rust-lang / rust-lang/rustfmt

[unstable option] doc_comment_code_block_small_heuristics

Open
#6,942 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Tracking issue for unstable option: doc_comment_code_block_small_heuristics.
This option was added by https://github.com/rust-lang/rustfmt/pull/6616

Option documentation.

See Processes.md, "Stabilising an Option":

  • Is the default value correct?
  • The design and implementation of the option are sound and clean.
  • The option is well tested, both in unit tests and, optimally, in real usage.
  • There is no open bug about the option that prevents its use.

Also see:

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 with the option documentation for doc_comment_code_block_small_heuristics, the implementation introduced by rustfmt PR 6616, and Processes.md's “Stabilising an Option” section. Review the linked configuration-stabilization discussions and determine what remains for the design, implementation, tests, and open-bug checks to be complete. Done means the option satisfies the unchecked stabilization criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.