Phrasing of Sync and Send
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 2.3k
- Forks
- 325
- PR merge metrics
- No merged PRs in 30d
Description
The current documentation describes Send and Sync in this way:
A type is Send if it is safe to send it to another thread.
A type is Sync if it is safe to share between threads (T is Sync if and only if &T is Send).
This wording is unclear to me, overly formal yet vague (what does it mean, exactly, "send to another thread"?)
Proposed change:
Send: A type is Send if it can be moved into another thread.
Sync: A type is Sync if it can be borrowed into another thread. (T is Sync if and only if &T is Send)
This phrasing doesn't change the meaning but makes it much more clear IMHO.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation passage that defines Send and Sync, then compare its current wording with the proposed phrasing in this issue. Update the descriptions without changing the stated equivalence, and verify that the rendered documentation clearly explains moving and borrowing values between threads.
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
- 55/100