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

Document Safety #3

Open
ohchase opened this issue Apr 4, 2024 · 0 comments
Open

Document Safety #3

ohchase opened this issue Apr 4, 2024 · 0 comments
Assignees
@ohchase
Labels
documentation Improvements or additions to documentation

Comments

@ohchase
Copy link
Owner

ohchase commented Apr 4, 2024

This library has to use unsafe code because it is interacting with memory at runtime.
There is no sufficient documentation on functions I did not expose as unsafe with unsafe blocks inside.
Should document all the unsafe blocks, and confirm it is appropriate to actually expose the functions as safe after confirming all the requirements.
@ohchase ohchase added the documentation Improvements or additions to documentation label Apr 4, 2024
@ohchase ohchase self-assigned this Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ohchase ohchase

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ohchase