rust-lang/rustfmt

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

Open

#5496 aperta il 11 ago 2022

Vedi su GitHub
 (6 commenti) (0 reazioni) (1 assegnatario)Rust (760 fork)batch import
A-configE-needs-testgood first issue

Metriche repository

Star
 (4893 star)
Metriche merge PR
 (Merge medio 10g 21h) (8 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Migliora la documentazione aggiungendo snippet di codice e chiarendo il comportamento con version=Two, e aggiungi casi di test nelle directory tests/source/configs/ e tests/target/configs/ seguendo la guida per i contributori.
Tech stack
rust
Dominio
tooling
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RustGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80