Include AtomicU128/AtomicI128 in docs for any target#155811
Open
pluiee wants to merge 1 commit intorust-lang:mainfrom
Open
Include AtomicU128/AtomicI128 in docs for any target#155811pluiee wants to merge 1 commit intorust-lang:mainfrom
pluiee wants to merge 1 commit intorust-lang:mainfrom
Conversation
This comment has been minimized.
This comment has been minimized.
cbcafea to
6e7e00b
Compare
Collaborator
|
rustbot has assigned @Mark-Simulacrum. Use Why was this reviewer chosen?The reviewer was selected based on:
|
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
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.
Fixes #130474
This is my first contribution, so I'll try to be as descriptive as possible of my process and thoughts.
./x doc library/core --target x86_64-unknown-linux-gnu(building the std doc didn't seem to apply my local changes so I used the core doc) Check the screenshots below.#[cfg(any(...,doc))]to all required structs and implementations so the types would compile. Applyingtarget_has_atomic_equal_alignmentpart wasn't explicitly necessary, but adding it reveals the whole methods (specificallyfrom_mutandfrom_mut_slice).u128/i128[Before]

[After]

After the first work, doc tests were failing in CI, so I added

#[$cfg_cas]to all methods in theatomic_intmacro to cover them. But I'm not really sure if all these changes are necessary (and appropriate).This also has a side-effect of stating "Available on target_has_atomic=128 only." for all methods with the attribute. Also not sure if this is a good behavior..