rust-lang / rust-lang/nomicon

the Atomics page left me confused about "relaxed". What is it for?

Open
#309 7 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

Atomics

The example of a counter is given, the counter would keep an accurate count, but no guarantee is given that another thread reading the counter will get the final, up to date count?

If there's no guarantee that the count being read is correct, from the perspective of a reader, why ever read from it? Why bother with it at all?

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 Atomics page at doc.rust-lang.org/nightly/nomicon/atomics.html, especially the counter example and its explanation of relaxed ordering. Review the surrounding text to determine what guarantee is missing for readers and what use case the example should communicate. Done means the page clearly explains what relaxed provides, what it does not provide, and why reading such a counter can still be useful.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.