rust-lang/rustfmt

Improve Documentation For `single_line_if_else_max_width` in `Configurations.md` + Add Tests

Open

#5,496 opened on Aug 11, 2022

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Rust (4,893 stars) (760 forks)batch import
A-configE-needs-testgood first issue

Description

The single_line_if_else_max_width is one of many configuration options that could use some improvements to it's documentation. It would be great to:

  • Add code snippets to highlight the functionality this option provides
  • Describe that the behavior of this option changes when version=Two is set.

Additionally, some tests for the options should be added to tests/source/configs/ and tests/target/configs/. See the Create test cases section of the Contributing guide for more details. It would be great to have test cases for both version=One and version=Two.

Contributor guide

Tech stack
rust
Domain
documentationtesting
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RustTesting basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue involves improving documentation for `single line if else max width` in `Configurations.md` and adding test cases in `tests/source/configs/` and `tests/target/configs/`. Refer to the Contributing guide for test case creation. The behavior changes with `version=Two`, so test cases for both versions are needed.