rust-unofficial/patterns

Consistent Headline Capitalization?

Open

#387 opened on Jan 29, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Shell (6,622 stars) (292 forks)batch import
C-enhancementM-maintenancegood first issue

Description

Is this book using Headline Capitalization or Sentence capitaliztion for headers? From a quick scan it seems Headline Capitalization is used (except when it isn't).

E.g. in Constructors:

Default Constructors vs. See also (should be See Also, this is incorrectly capitalized everywhere I looked).

Or in Struct decomposition for independent borrowing (should be Struct Decomposition for Independent Borrowing).

Etc.

Would you accept a PR that unifies this?

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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of Rust documentationfamiliarity with markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue requests consistent headline capitalization in the Rust Patterns book. To fix, locate all markdown files in the repository (likely under /patterns/src/), identify headers, and ensure they follow a chosen style (e.g., Title Case vs. Sentence case). The author suggests most headers use Title Case but some use Sentence case. A PR should unify all headers to the dominant style. Tools like grep or a simple script can help find all headers. No maintainer response is needed; the scope is clear.