rust-unofficial/patterns

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

Open

#338 opened on Jan 10, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Shell (6,622 stars) (292 forks)batch import
A-patternC-clarificationgood first issue

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.

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Rust knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the current text in section 3.2.1 of the patterns repository (likely in the book/ directory). Review the Rust API Guidelines link provided in the issue. Propose additional clarifying sentences to reconcile the naming convention.
Clarify naming convention of `build()` in section 3.2.1 · rust-unofficial/patterns#338 | Good First Issue