rust-lang / rust-lang/book

Chapter 16.2: Possibly Unnecessary Analogy

Open
#4,516 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
18.3k
Forks
4.1k
Avg merge
14m
Merged PRs (30d)
1

Description

URL to the section(s) of the book with this problem:
https://doc.rust-lang.org/book/ch16-02-message-passing.html

Description of the problem:
Sending information via a communication channel is something I believe most people would be able understand well even without an analogy. While I found the analogy of a rubber duck floating down the river quite adorable, in my opinion, it lengthens the introduction unnecessarily. Though, this is not a big issue, obviously, maybe even a bit nitpicky of me.

Suggested fix:
Reword and shorten paragraphs 3 and 4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open src/ch16-02-message-passing.md around lines 16–25 and compare it with the rendered Chapter 16.2 section. Review paragraphs 3 and 4 for the rubber-duck analogy, then reword and shorten them while preserving the introduction’s explanation of channels. Done means the introduction is more concise and the updated wording remains clear in the rendered book.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.