rust-lang / rust-lang/nomicon

Send and Sync page has a confusing start

Open
#307 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
2.3k
Forks
325
PR merge metrics
No merged PRs in 30d

Description

This first sentence of the page "Send and Sync" (section 8.2 currently) is:

Not everything obeys inherited mutability, though.

This doesn't follow logically from the previous page and therefore makes no sense. Even if it did, it presupposes that the reader has just read the previous page. I suggest it is removed or reworded to make sense in isolation.

Contributor guide

No contributing guide indexed for this repository

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

Start with the first sentence of the “Send and Sync” page, section 8.2, and compare it with the surrounding opening text. Remove or reword “Not everything obeys inherited mutability, though.” so the page makes sense in isolation, then review the rendered page for a clear standalone introduction.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.