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

Add SAFETY comments and notes for unsafe blocks #79

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

cblichmann
Copy link

This change add SAFETY commands and note for unsafe blocks that came up during an internal "unsafe review".
Adding such comments should make the code easier to reason about and it seems beneficial to retain the result of our internal review.

Copy link
Member

@notgull notgull left a comment

Choose a reason for hiding this comment

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

Thanks! I know this was a lot of effort.

Some of the comments have weird word wrap. Could you make sure your new comments respect a common character limit across all files?

@cblichmann
Copy link
Author

[...]
Some of the comments have weird word wrap. Could you make sure your new comments respect a common character limit across all files?

All comments should be < 100 chars per line. The /// comments seem to be longer.

Any other preference?

Copy link
Member

@notgull notgull left a comment

Choose a reason for hiding this comment

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

Thanks!

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

Successfully merging this pull request may close these issues.

2 participants