rust-lang/rustfmt

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

Open

#5,496 建立於 2022年8月11日

在 GitHub 查看
 (6 留言) (0 反應) (1 負責人)Rust (4,893 star) (760 fork)batch import
A-configE-needs-testgood first issue

描述

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.

貢獻者指南

技術棧
rust
領域
documentationtesting
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
RustTesting basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
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.