rust-unofficial/patterns

Clarify naming convention of `build()` in section 3.2.1

Ouverte

#338 ouverte le 10 janv. 2023

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)Shell (292 forks)batch import
A-patternC-clarificationgood first issue

Métriques du dépôt

Stars
 (6 622 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

The current builder design pattern implies that the method the produces whatever is being built should be named build(), which seems to contradict the Rust API Guidelines on the same subject.

I think there should be some clarifying language around this: whether the method should always be named build(), or be adapted to fit the API.

Guide contributeur

Direction de recherche
Consultez les directives de l'API Rust sur les builders et la documentation actuelle pour proposer un langage clarificateur.
Stack technique
rust
Domaine
documentation
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
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
Rust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90