rust-lang/rustfmt

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

Open

#5.496 geöffnet am 11. Aug. 2022

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (760 Forks)batch import
A-configE-needs-testgood first issue

Repository-Metriken

Stars
 (4.893 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 10T 21h) (8 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Verbessere die Dokumentation durch Hinzufügen von Codeausschnitten und Klärung des Verhaltens mit version=Two, und füge Testfälle in den Verzeichnissen tests/source/configs/ und tests/target/configs/ gemäß dem Contributing Guide hinzu.
Tech Stack
rust
Domain
tooling
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RustGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80