rust-lang / rust-lang/rustfmt

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

Open
#5,496 6 comments 0 reactions 1 assignee View on GitHub

@truls-p is already working on this.

Since Aug 16, 2022.

A-config E-needs-test good first issue
Dominant language
Rust
Stars
7k
Forks
1.1k
Avg merge
2d 13h
Merged PRs (30d)
24

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

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.