rust-lang/rustfmt

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

Open

#5 496 ouverte le 11 août 2022

Voir sur GitHub
 (6 commentaires) (0 réactions) (1 assigné)Rust (760 forks)batch import
A-configE-needs-testgood first issue

Métriques du dépôt

Stars
 (4 893 stars)
Métriques de merge PR
 (Merge moyen 10j 21h) (8 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Améliorez la documentation en ajoutant des extraits de code et en clarifiant le comportement avec version=Two, et ajoutez des cas de test dans les répertoires tests/source/configs/ et tests/target/configs/ en suivant le guide de contribution.
Stack technique
rust
Domaine
tooling
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RustGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80