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 (292 forks)batch import
A-patternC-clarificationgood first issue

Repository metrics

Stars
 (6,622 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the Rust API Guidelines on builders and the current documentation to propose clarifying language.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90