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.

Sign up for GitHub

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

Jump to bottom

Add a comment for every return #525

Open

gperciva wants to merge 3 commits into master from comments-return

Member

gperciva commented Aug 8, 2024

No description provided.

gperciva added 3 commits

August 7, 2024 21:36


          Comments: "Not supported" or "Do nothing" for return statements

bb2df0b


          Comments: allow & use "Done!" for return statements

51a6f69


          Comments: clarify remaining return statements

5dc8e90

Member Author

gperciva commented Aug 8, 2024

With two exceptions[1], this PR ensures that every return statement is annotated.

main change: added /* Done! */ to STYLE (and apply).

This is for things like return (ret) where it's not appropriate to say either /* Success! */ or /* Failure! */. Also for returning a mathematical result, such as return (state).
secondary change: added /* Do nothing. */ where appropriate.
third: described the 8 remaining returns which were left un-annotated.

[1] Did not comment sysendian.h, or the return (mpool_malloc(... because that was in the middle of a huge macro.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet