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.

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 safety comments for unsafe portions of code. #15

Closed
Yossipossi1 opened this issue Jul 6, 2023 · 4 comments
Closed

Add safety comments for unsafe portions of code. #15

Yossipossi1 opened this issue Jul 6, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@Yossipossi1
Copy link
Contributor

See #14 for full comments.

Some portions utilize unsafe code to optimize performance. It would be useful for developers (current and future) if the purpose and invariants of the unsafe code were laid out in a comment to prevent violations.
@null8626
Copy link
Owner

null8626 commented Jul 7, 2023

Thank you for this, will do as soon as i can!

@null8626
Copy link
Owner

null8626 commented Jul 7, 2023

Is this commit enough? Because i think that's probably the only unsafe use here that has to do with user-generated input. The rest is pretty much related to the usage of the internal codepoints binary, where the library obviously have no other choice than manually manage pointers.

@null8626 null8626 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 7, 2023
@Yossipossi1
Copy link
Contributor Author

Sure, those look good! I appreciate it! ^^

@null8626
Copy link
Owner

null8626 commented Jul 8, 2023

No problem! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@null8626 @Yossipossi1