Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update wording for @cmpxchgStrong and @cmpxchgWeak in langref.html.in #20411

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

toziegler
Copy link

The previous wording was incorrect as it indicated that @cmpxchgStrong and @cmpxchgWeak return null on "failure" even though it returns null on success and the current value of the atomic on "failure", closes #19979.

Further documentation might be helpful as described in #1516.

The previous wording was incorrect as it indicated that `@cmpxchgStrong` and `@cmpxchgWeak` return `null` on "failure" even though it returns `null` on success and the current value of the atomic on "failure", see ziglang#19979. 

Further documentation might be helpful as described in ziglang#1516.
Copy link

@diffuty diffuty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix. I was also confused reading here the other day.

I don't have any privilege to the repository. Approving just means I like this change.

doc/langref.html.in Outdated Show resolved Hide resolved
doc/langref.html.in Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect documentation for @cmpxchgStrong and @cmpxchgWeak
2 participants