Document almost all of atomics. #19108
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
| /// # Examples | ||
| /// | ||
| /// ``` | ||
| /// use core::atomic::AtomicBool; |
There was a problem hiding this comment.
The primary interface for these examples is through std::sync, so could these imports be written to use that instead?
There was a problem hiding this comment.
Yeah, this was the motivation for the IRC discussion. Will update.
steveklabnik
force-pushed
the
doc_atomic_bool
branch
from
4b53d46 to
4f5553a
Compare
|
Updated! |
steveklabnik
force-pushed
the
doc_atomic_bool
branch
from
4f5553a to
a2b6d1f
Compare
| /// | ||
| /// ``` | ||
| /// use std::sync::atomic::AtomicPtr; | ||
| /// use std::sync::atomic::Ordering; |
There was a problem hiding this comment.
Could you also import both of these in the same statement? (use std::sync::atomic::{AtomicPtr, Ordering};), and above as well.
|
Thanks @steveklabnik! r=me with one nit |
I don't know enough about the free functions to give them better docs right now.
steveklabnik
force-pushed
the
doc_atomic_bool
branch
from
a2b6d1f to
40aa833
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don't know enough about the free functions to give them better docs right now.