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

Typos in comments in futex_windows.odin #4632

Open
TylerWerne40 opened this issue Dec 27, 2024 · 2 comments
Open

Typos in comments in futex_windows.odin #4632

TylerWerne40 opened this issue Dec 27, 2024 · 2 comments

Comments

@TylerWerne40
Copy link

Context

I was browsing the sync docs and found this issue in Odin/core/sync/futex_windows.odin. Typos in the comments make the meaning somewhat unclear. If I should submit a PR to fix the comments, let me know.

Expected Behavior

Correct English.

Current Behavior

Line 23:
/*
NOTE(bill, 2022-08-17)
WaitOnAddress is implemented on top of RtlWaitOnAddress
BUT requires taking the return value of it and if it is non-zero
converting that status to a DOS error and then SetLastError
If this is not done, then things don't work as expected when
and error occurs

GODDAMN MICROSOFT!

*/

...
Line 49:
// NOTE(bill): for some bizarre reason, this has be a negative number

Expected meaning

Line 23:
/*
NOTE(bill, 2022-08-17)
WaitOnAddress is implemented on top of RtlWaitOnAddress
BUT requires taking the return value of it and if it is non-zero
converting that status to a DOS error and then SetLastError
If this is not done, then things don't work as expected when
an error occurs

GODDAMN MICROSOFT!

*/

...
Line 49:
// NOTE(bill): for some bizarre reason, this has to be a negative number

@israfiel-a
Copy link

I have not contributed to Odin yet, but this should be a PR, no? Just a simple documentation extension.

@laytan
Copy link
Collaborator

laytan commented Dec 30, 2024

Is the only change here a "this has be" -> "this has to be"? Bit of an exaggeration to say it makes it unclear.

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

No branches or pull requests

3 participants