[Doc] Fix doc quality check flagged issues on atomics.md#792
Open
hughperkins wants to merge 4 commits into
Open
[Doc] Fix doc quality check flagged issues on atomics.md#792hughperkins wants to merge 4 commits into
hughperkins wants to merge 4 commits into
Conversation
Address doc-quality review for atomics.md: - confine IR memory-scope spellings and native-vs-CAS lowering detail to a new '## Under the hood (advanced)' section - drop internal C++ source-file citations, compiler-pass names, and RHI error details from end-user prose; keep the user-facing behavior - define bit-packed/quantized fields inline instead of 'quant snodes'
The per-backend volatile_load lowering table describes IR/codegen/backend internals (PTX, SPIR-V MemoryAccess, SPIRV-Cross); relocate it under '## Under the hood (advanced)' and leave a user-facing pointer in the semantics section.
hughperkins
marked this pull request as ready for review
July 20, 2026 13:23
Collaborator
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Bravo. Reviewed commit: ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
The edited table footnotes used the daggers † / ‡, which the check_non_ascii CI flags on added lines. Convert the † / ‡ / § footnote scheme to ASCII [1] / [2] / [3] (definitions and references) for the What's available table.
- atomic_min/max table: drop LLVM/GLSL IR internals (llvm.minnum/maxnum, atomicrmw fmin/fmax, GLSL FMin/FMax) and the native-vs-CAS mechanics column; keep the user-facing f16 support and NaN-result behavior - atomic_exchange table cell: drop the 'via uint-bitcast' codegen mechanic - CPU 'native' note: reword to describe user-visible behavior, not codegen - un-wrap the advanced-section intro paragraph (.md prose must not be wrapped)
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
1 participant
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.
Issue: #
Brief Summary
copilot:summary
Walkthrough
copilot:walkthrough